Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixed stale URL references #85

Merged
merged 1 commit into from
Dec 3, 2022
Merged

Fixed stale URL references #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@

<h4><p align='center'>
<a href="https://www.mosaicml.com">[Website]</a>
- <a href="https://docs.mosaicml.com/projects/streaming/en/latest/getting_started/user_guide.html">[Getting Started]</a>
- <a href="https://docs.mosaicml.com/projects/streaming/">[Docs]
- <a href="https://streaming.docs.mosaicml.com/en/latest/getting_started/user_guide.html">[Getting Started]</a>
- <a href="https://streaming.docs.mosaicml.com/">[Docs]
- <a href="https://www.mosaicml.com/team">[We're Hiring!]</a>
</p></h4>

Expand All @@ -34,7 +34,7 @@
<a href="https://pypi.org/project/mosaicml-streaming/">
<img alt="PyPi Downloads" src="https://img.shields.io/pypi/dm/mosaicml-streaming">
</a>
<a href="https://docs.mosaicml.com/projects/streaming">
<a href="https://streaming.docs.mosaicml.com">
<img alt="Documentation" src="https://readthedocs.org/projects/streaming/badge/?version=stable">
</a>
<a href="https://join.slack.com/t/mosaicml-community/shared_invite/zt-w0tiddn9-WGTlRpfjcO9J5jyrMub1dg">
Expand All @@ -54,7 +54,7 @@ Streaming is a PyTorch compatible dataset that enables users to stream training
dataloader = torch.utils.data.DataLoader(dataset=ImageStreamingDataset(remote='s3://...'))
```

Please check the [quick start guide](https://docs.mosaicml.com/projects/streaming/en/latest/getting_started/quick_start.html) and [user guide](https://docs.mosaicml.com/projects/streaming/en/latest/getting_started/user_guide.html) on how to use the Streaming Dataset.
Please check the [quick start guide](https://streaming.docs.mosaicml.com/en/latest/getting_started/quick_start.html) and [user guide](https://streaming.docs.mosaicml.com/en/latest/getting_started/user_guide.html) on how to use the Streaming Dataset.

# Key Benefits

Expand All @@ -75,10 +75,10 @@ pip install mosaicml-streaming
```

# Examples
Please check our [Examples](https://docs.mosaicml.com/projects/streaming/) section for the end-to-end model training workflow using Streaming datasets.
Please check our [Examples](https://streaming.docs.mosaicml.com/) section for the end-to-end model training workflow using Streaming datasets.

# 📚 Documentation
Getting started guides, examples, API reference, and other useful information can be found in our [docs](https://docs.mosaicml.com/projects/streaming).
Getting started guides, examples, API reference, and other useful information can be found in our [docs](https://streaming.docs.mosaicml.com).

# 💫 Contributors
We welcome any contributions, pull requests, or issues!
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -521,7 +521,7 @@ def visit_reference(self, node: Element) -> None:
if 'refid' not in node and (
not any(node['refuri'].startswith(x)
for x in ('/', 'https://docs.mosaicml.com', '#')) or
node['refuri'].startswith('https://docs.mosaicml.com/projects/streaming') or
node['refuri'].startswith('https://streaming.docs.mosaicml.com') or
node['refuri'].startswith('https://docs.mosaicml.com/projects/yahp')):
# If there's a refid, or the refuri starts with a non-external uri scheme, then it's an internal
# (hardcoded) link, so don't open that in a new tab
Expand Down
8 changes: 4 additions & 4 deletions examples/cifar10.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@
"\n",
"Let's get started!\n",
"\n",
"[streaming_dataset]: https://docs.mosaicml.com/projects/streaming/en/latest/api_reference/generated/streaming.Dataset.html\n",
"[streaming_dataset_mds_writer]: https://docs.mosaicml.com/projects/streaming/en/latest/api_reference/generated/streaming.MDSWriter.html"
"[streaming_dataset]: https://streaming.docs.mosaicml.com/en/latest/api_reference/generated/streaming.Dataset.html\n",
"[streaming_dataset_mds_writer]: https://streaming.docs.mosaicml.com/en/latest/api_reference/generated/streaming.MDSWriter.html"
]
},
{
Expand Down Expand Up @@ -190,7 +190,7 @@
"\n",
"For more information on the `MDSWriter` check out the [API reference][api].\n",
"\n",
"[api]: https://docs.mosaicml.com/projects/streaming/en/latest/api_reference/generated/streaming.MDSWriter.html"
"[api]: https://streaming.docs.mosaicml.com/en/latest/api_reference/generated/streaming.MDSWriter.html"
]
},
{
Expand Down Expand Up @@ -240,7 +240,7 @@
"\n",
"We extend Streaming's `Dataset` to deserialize the data.\n",
"\n",
"For more information on the Streaming `Dataset` parent class check out the [API reference](https://docs.mosaicml.com/projects/streaming/en/latest/api_reference/generated/streaming.Dataset.html)."
"For more information on the Streaming `Dataset` parent class check out the [API reference](https://streaming.docs.mosaicml.com/en/latest/api_reference/generated/streaming.Dataset.html)."
]
},
{
Expand Down
8 changes: 4 additions & 4 deletions examples/facesynthetics.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@
"\n",
"Let's get started!\n",
"\n",
"[streaming_dataset]: https://docs.mosaicml.com/projects/streaming/en/latest/api_reference/generated/streaming.Dataset.html\n",
"[streaming_dataset_mds_writer]: https://docs.mosaicml.com/projects/streaming/en/latest/api_reference/generated/streaming.MDSWriter.html"
"[streaming_dataset]: https://streaming.docs.mosaicml.com/en/latest/api_reference/generated/streaming.Dataset.html\n",
"[streaming_dataset_mds_writer]: https://streaming.docs.mosaicml.com/en/latest/api_reference/generated/streaming.MDSWriter.html"
]
},
{
Expand Down Expand Up @@ -278,7 +278,7 @@
"\n",
"For more information on the `MDSWriter` check out the [API reference][api].\n",
"\n",
"[api]: https://docs.mosaicml.com/projects/streaming/en/latest/api_reference/generated/streaming.MDSWriter.html"
"[api]: https://streaming.docs.mosaicml.com/en/latest/api_reference/generated/streaming.MDSWriter.html"
]
},
{
Expand Down Expand Up @@ -331,7 +331,7 @@
"\n",
"We extend Streaming's `Dataset` to deserialize the binary data and convert the labels to one-hot encoding.\n",
"\n",
"For more information on the Streaming `Dataset` parent class check out the [API reference](https://docs.mosaicml.com/projects/streaming/en/latest/api_reference/generated/streaming.Dataset.html)."
"For more information on the Streaming `Dataset` parent class check out the [API reference](https://streaming.docs.mosaicml.com/en/latest/api_reference/generated/streaming.Dataset.html)."
]
},
{
Expand Down
10 changes: 5 additions & 5 deletions examples/synthetic_nlp.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@
"\n",
"Let's get started!\n",
"\n",
"[streaming_dataset]: https://docs.mosaicml.com/projects/streaming/en/latest/api_reference/generated/streaming.Dataset.html\n",
"[streaming_dataset_mds_writer]: https://docs.mosaicml.com/projects/streaming/en/latest/api_reference/generated/streaming.MDSWriter.html"
"[streaming_dataset]: https://streaming.docs.mosaicml.com/en/latest/api_reference/generated/streaming.Dataset.html\n",
"[streaming_dataset_mds_writer]: https://streaming.docs.mosaicml.com/en/latest/api_reference/generated/streaming.MDSWriter.html"
]
},
{
Expand Down Expand Up @@ -318,7 +318,7 @@
"\n",
"We are going to use the `MDSWriter` to convert the raw synthetic NLP dataset into a `.mds` file format.\n",
"\n",
"For more information on the Streaming `MDSWriter` class check out the [API reference](https://docs.mosaicml.com/projects/streaming/en/latest/api_reference/generated/streaming.MDSWriter.html)."
"For more information on the Streaming `MDSWriter` class check out the [API reference](https://streaming.docs.mosaicml.com/en/latest/api_reference/generated/streaming.MDSWriter.html)."
]
},
{
Expand Down Expand Up @@ -396,7 +396,7 @@
"\n",
"We extend Streaming's `Dataset` to deserialize the data. Let's verify the dataloading samples from Streaming's `Dataset` class with the raw samples for content validity and deterministic sample ordering.\n",
"\n",
"For more information on the Streaming `Dataset` parent class check out the [API reference](https://docs.mosaicml.com/projects/streaming/en/latest/api_reference/generated/streaming.Dataset.html)."
"For more information on the Streaming `Dataset` parent class check out the [API reference](https://streaming.docs.mosaicml.com/en/latest/api_reference/generated/streaming.Dataset.html)."
]
},
{
Expand Down Expand Up @@ -437,7 +437,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Below are some utility methods about the dataset which would be highly useful for debugging and model training. For more information on the Streaming `Dataset` parameters, check out the [API reference](https://docs.mosaicml.com/projects/streaming/en/latest/api_reference/generated/streaming.Dataset.html)."
"Below are some utility methods about the dataset which would be highly useful for debugging and model training. For more information on the Streaming `Dataset` parameters, check out the [API reference](https://streaming.docs.mosaicml.com/en/latest/api_reference/generated/streaming.Dataset.html)."
]
},
{
Expand Down