Changing 'stable' to 'latest' in notebooks in examples (mosaicml#1534)

* Fixed references

* Fixing typo

Co-authored-by: dblalock <[email protected]>

Co-authored-by: Hanlin Tang <[email protected]>
Co-authored-by: dblalock <[email protected]>

Author: 3 people

examples/early_stopping.ipynb

@@ -32,8 +32,8 @@
     "\n",
     "Let's get started!\n",
     "\n",
-    "[earlystopper]: https://docs.mosaicml.com/en/stable/api_reference/composer.callbacks.early_stopper.html#composer.callbacks.early_stopper.EarlyStopper\n",
-    "[thresholdstopper]: https://docs.mosaicml.com/en/stable/api_reference/composer.callbacks.threshold_stopper.html#composer.callbacks.threshold_stopper.ThresholdStopper\n",
+    "[earlystopper]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.callbacks.EarlyStopper.html\n",
+    "[thresholdstopper]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.callbacks.ThresholdStopper.html\n",
     "[getting_started]: https://docs.mosaicml.com/en/stable/examples/getting_started.html\n",
     "[welcome_tour]: https://docs.mosaicml.com/en/stable/getting_started/welcome_tour.html"
    ]
@@ -134,7 +134,7 @@
     "\n",
     "Finally, set up the model, optimizer, scheduler, and an [evaluator][evaluator].\n",
     "\n",
-    "[evaluator]: https://docs.mosaicml.com/en/stable/api_reference/composer.core.evaluator.html#composer.core.evaluator.Evaluator"
+    "[evaluator]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.Evaluator.html#evaluator"
    ]
   },
   {
@@ -194,10 +194,10 @@
     "\n",
     "See the [API Reference][api] for more information.\n",
     "\n",
-    "[evaluator]: https://docs.mosaicml.com/en/stable/api_reference/composer.core.evaluator.html#composer.core.evaluator.Evaluator\n",
-    "[trainer]: https://docs.mosaicml.com/en/stable/api_reference/composer.trainer.trainer.html#composer.trainer.trainer.Trainer\n",
-    "[time]: https://docs.mosaicml.com/en/stable/trainer/time.html\n",
-    "[api]: https://docs.mosaicml.com/en/stable/api_reference/composer.callbacks.early_stopper.html#composer.callbacks.early_stopper.EarlyStopper\n",
+    "[evaluator]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.Evaluator.html#evaluator\n",
+    "[trainer]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.Trainer.html#trainer\n",
+    "[time]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.Time.html#time\n",
+    "[api]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.callbacks.EarlyStopper.html\n",
     "\n",
     "Here, we'll use our callback to track the Accuracy metric over one epoch on the test dataset:"
    ]
@@ -266,7 +266,7 @@
     "-   `threshold`: The float threshold that dictates when to halt training.\n",
     "-   `stop_on_batch`: If `True`, training can halt in the middle of an epoch, rather than just add the end.\n",
     "\n",
-    "[thresholdstopper]: https://docs.mosaicml.com/en/stable/api_reference/composer.callbacks.threshold_stopper.html#composer.callbacks.threshold_stopper.ThresholdStopper"
+    "[thresholdstopper]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.callbacks.ThresholdStopper.html"
    ]
   },
   {

examples/getting_started.ipynb

@@ -38,7 +38,7 @@
     "\n",
     "[welcome_tour]: https://docs.mosaicml.com/en/stable/getting_started/welcome_tour.html\n",
     "[pytorch_basics]: https://pytorch.org/tutorials/beginner/basics/intro.html\n",
-    "[trainer]: https://docs.mosaicml.com/en/stable/api_reference/composer.trainer.trainer.html#composer.trainer.trainer.Trainer"
+    "[trainer]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.Trainer.html#trainer"
    ]
   },
   {
@@ -156,7 +156,7 @@
     "**Note**: The model below is an instance of a [ComposerModel][composer_model]. Models need to be wrapped in this class, which provides a convenient interface between the underlying PyTorch model and the Trainer.\n",
     "\n",
     "[custom_models_tutorial]: https://docs.mosaicml.com/en/stable/tutorials/adding_models_datasets.html#models\n",
-    "[composer_model]: https://docs.mosaicml.com/en/stable/api_reference/composer.models.base.html#composer.models.base.ComposerModel"
+    "[composer_model]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.ComposerModel.html#composer.ComposerModel"
    ]
   },
   {
@@ -228,7 +228,7 @@
     "\n",
     "Finally, we instantiate an [InMemoryLogger][in_memory_logger] that records all the data from the Composer Trainer. We will use this logger to generate data plots after we complete training.\n",
     "\n",
-    "[in_memory_logger]: https://docs.mosaicml.com/en/stable/api_reference/composer.loggers.in_memory_logger.html"
+    "[in_memory_logger]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.loggers.InMemoryLogger.html"
    ]
   },
   {
@@ -272,7 +272,7 @@
     "\n",
     "\n",
     "[trainer_docs]: https://docs.mosaicml.com/en/stable/trainer/using_the_trainer.html\n",
-    "[api]: https://docs.mosaicml.com/en/stable/api_reference/composer.trainer.trainer.html#composer.trainer.trainer.Trainer\n",
+    "[api]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.Trainer.html#trainer\n",
     "[composer_model]: https://docs.mosaicml.com/en/stable/composer_model.html\n",
     "[dataloaders]: https://docs.mosaicml.com/en/stable/trainer/dataloaders.html\n",
     "[time]: https://docs.mosaicml.com/en/stable/trainer/time.html\n",

examples/huggingface_models.ipynb

@@ -158,7 +158,7 @@
     "\n",
     "See the [API Reference][api] for additional details.\n",
     "\n",
-    "[api]: https://docs.mosaicml.com/en/stable/api_reference/composer.models.huggingface.html#composer.models.huggingface.HuggingFaceModel"
+    "[api]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.models.HuggingFaceModel.html"
    ]
   },
   {
@@ -222,7 +222,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "We will now specify a Composer `Trainer` object and run our training! `Trainer` has many arguments that are described in our [documentation](https://docs.mosaicml.com/en/stable/api_reference/composer.trainer.trainer.html), so we'll discuss only the less-obvious arguments used below:\n",
+    "We will now specify a Composer `Trainer` object and run our training! `Trainer` has many arguments that are described in our [documentation](https://docs.mosaicml.com/en/stable/api_reference/generated/composer.Trainer.html#trainer), so we'll discuss only the less-obvious arguments used below:\n",
     "\n",
     "- `max_duration` - a string specifying how long to train. This can be in terms of batches (e.g., `'10ba'` is 10 batches) or epochs (e.g., `'1ep'` is 1 epoch), [among other options][time].\n",
     "- `schedulers` - a (list of) PyTorch or Composer learning rate scheduler(s) that will be composed together.\n",

examples/training_without_local_storage.ipynb

@@ -249,17 +249,17 @@
     "\n",
     "* [Logger][Logger]: Composer includes a centralized logger, which passes logged data to each `LoggerDestination` (more on that below). Logged data can be either metrics or artifacts. The logger is similar to Python's built-in `logging.getLogger(...)` but is designed to log structured metrics and artifacts in addition to just text.\n",
     "\n",
-    "[Logger]: https://docs.mosaicml.com/en/stable/api_reference/composer.loggers.logger.html#composer.loggers.logger.Logger\n",
+    "[Logger]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.Logger.html#logger\n",
     "\n",
     "* [LoggerDestination][LoggerDestination]: Where logs are sent is specified via the `loggers` argument of the [Trainer constructor][trainer]. The centralized `Logger` (above) passes all metrics and artifacts to each `LoggerDestination`, which is responsible for handling and storing the data. For example, Composer includes `LoggerDestination`s for logging to [files][FileLogger], [TensorBoard][TensorboardLogger], [Weights & Biases][wandb], and [Object Stores][ObjectStoreLogger] like S3. Not all `LoggerDestination`s support storing all types of data; for example, the [ObjectStoreLogger][ObjectStoreLogger] only supports logging artifacts, whereas the [FileLogger][FileLogger] only supports logging files. Others, such as the [WandBLogger][wandb], support both.\n",
     "\n",
-    "[LoggerDestination]: https://docs.mosaicml.com/en/stable/api_reference/composer.loggers.logger_destination.html#composer.loggers.logger_destination.LoggerDestination\n",
-    "[trainer]: https://docs.mosaicml.com/en/stable/api_reference/composer.trainer.trainer.html#composer.trainer.trainer.Trainer\n",
-    "[FileLogger]: https://docs.mosaicml.com/en/stable/api_reference/composer.loggers.file_logger.html#composer.loggers.file_logger.FileLogger\n",
-    "[TensorboardLogger]: https://docs.mosaicml.com/en/stable/api_reference/composer.loggers.tensorboard_logger.html#composer.loggers.tensorboard_logger.TensorboardLogger\n",
-    "[wandb]: https://docs.mosaicml.com/en/stable/api_reference/composer.loggers.wandb_logger.html#composer.loggers.wandb_logger.WandBLogger\n",
-    "[ObjectStoreLogger]: https://docs.mosaicml.com/en/stable/api_reference/composer.loggers.object_store_logger.html#composer.loggers.object_store_logger.ObjectStoreLogger\n",
-    "[FileLogger]: https://docs.mosaicml.com/en/stable/api_reference/composer.loggers.file_logger.html#composer.loggers.file_logger.FileLogger\n",
+    "[LoggerDestination]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.loggers.LoggerDestination.html\n",
+    "[trainer]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.Trainer.html#trainer\n",
+    "[FileLogger]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.loggers.FileLogger.html\n",
+    "[TensorboardLogger]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.loggers.TensorboardLogger.html#tensorboardlogger\n",
+    "[wandb]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.loggers.WandBLogger.html\n",
+    "[ObjectStoreLogger]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.loggers.ObjectStoreLogger.html#objectstorelogger\n",
+    "[FileLogger]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.loggers.FileLogger.html#filelogger\n",
     "\n",
     "* Metrics: A metric is a scalar, such as accuracy, that can be logged. Usually you would want to plot metrics over time (e.g., to see how accuracy improves over batches).\n",
     "\n",
@@ -268,15 +268,15 @@
     "* [ObjectStore][ObjectStore]: The abstract `ObjectStore` class provides an API for uploading and downloading checkpoints. Composer includes object store implementations for [S3][S3], [SFTP][SFTP], and [Libcloud][Libcloud]. You can also write your own implementation by extending the [base class][ObjectStore] if you are using a custom backend.\n",
     "\n",
     "[Artifacts]: https://docs.mosaicml.com/en/stable/trainer/artifact_logging.html\n",
-    "[ObjectStore]: https://docs.mosaicml.com/en/stable/api_reference/composer.utils.object_store.object_store.html#composer.utils.object_store.object_store.ObjectStore\n",
-    "[S3]: https://docs.mosaicml.com/en/stable/api_reference/composer.utils.object_store.s3_object_store.html#composer.utils.object_store.s3_object_store.S3ObjectStore\n",
-    "[SFTP]: https://docs.mosaicml.com/en/stable/api_reference/composer.utils.object_store.sftp_object_store.html#composer.utils.object_store.sftp_object_store.SFTPObjectStore\n",
-    "[Libcloud]: https://docs.mosaicml.com/en/stable/api_reference/composer.utils.object_store.libcloud_object_store.html#composer.utils.object_store.libcloud_object_store.LibcloudObjectStore\n",
+    "[ObjectStore]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.utils.ObjectStore.html\n",
+    "[S3]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.utils.S3ObjectStore.html\n",
+    "[SFTP]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.utils.SFTPObjectStore.html\n",
+    "[Libcloud]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.utils.LibcloudObjectStore.html\n",
     "\n",
     "We'll use these components together to back up our checkpoints and TensorBoard TF Event files to the cloud. Internally, the [CheckpointSaver][CheckpointSaver] callback and [TensorboardLogger][TensorboardLogger] pass all generated files to the [Logger][Logger] as artifacts by calling [Logger.file_artifact][Logger_file_artifact]. The Logger then passes these files to each [LoggerDestination][LoggerDestination] (specified via the `loggers` argument of the [Trainer constructor][trainer]). A `LoggerDestination`, which can implement the `log_file_artifact` method, is responsible for uploading the file to the cloud.\n",
     "\n",
-    "[CheckpointSaver]: https://docs.mosaicml.com/en/stable/api_reference/composer.callbacks.checkpoint_saver.html#composer.callbacks.checkpoint_saver.CheckpointSaver\n",
-    "[Logger_file_artifact]: https://docs.mosaicml.com/en/stable/api_reference/composer.loggers.logger.html#composer.loggers.logger.Logger.file_artifact\n",
+    "[CheckpointSaver]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.callbacks.CheckpointSaver.html#checkpointsaver\n",
+    "[Logger_file_artifact]: https://docs.mosaicml.com/en/stable/api_reference/generated/composer.Logger.html#composer.Logger.file_artifact\n",
     "\n",
     "\n",
     "Here, our \"cloud\" will be an S3 bucket. To upload checkpoints and TensorBoard TF Event files to the bucket, we'll add the [ObjectStoreLogger][ObjectStoreLogger] with the [S3ObjectStore][S3] backend to our list of logger destinations. This class asynchronously uploads artifacts to an object store without blocking the training loop."