From 59e5eccd308626a0c11659c0677204996774cb43 Mon Sep 17 00:00:00 2001 From: Bandish Shah Date: Fri, 2 Dec 2022 15:46:47 -0800 Subject: [PATCH] Fixed stale URL references --- README.md | 12 ++++++------ docs/source/conf.py | 2 +- examples/cifar10.ipynb | 8 ++++---- examples/facesynthetics.ipynb | 8 ++++---- examples/synthetic_nlp.ipynb | 10 +++++----- 5 files changed, 20 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 0a7c07bc2..681ee20bc 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,8 @@

[Website] -- [Getting Started] -- [Docs] +- [Getting Started] +- [Docs] - [We're Hiring!]

@@ -34,7 +34,7 @@ PyPi Downloads - + Documentation @@ -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 @@ -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! diff --git a/docs/source/conf.py b/docs/source/conf.py index c0f13b6c4..4c027d8e4 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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 diff --git a/examples/cifar10.ipynb b/examples/cifar10.ipynb index 41c6be4de..c14d587f8 100644 --- a/examples/cifar10.ipynb +++ b/examples/cifar10.ipynb @@ -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" ] }, { @@ -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" ] }, { @@ -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)." ] }, { diff --git a/examples/facesynthetics.ipynb b/examples/facesynthetics.ipynb index 7b688fa9c..f51748b86 100644 --- a/examples/facesynthetics.ipynb +++ b/examples/facesynthetics.ipynb @@ -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" ] }, { @@ -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" ] }, { @@ -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)." ] }, { diff --git a/examples/synthetic_nlp.ipynb b/examples/synthetic_nlp.ipynb index cc0ff6f0d..5aa8fa8bc 100644 --- a/examples/synthetic_nlp.ipynb +++ b/examples/synthetic_nlp.ipynb @@ -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" ] }, { @@ -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)." ] }, { @@ -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)." ] }, { @@ -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)." ] }, {