Skip to content

Conversation

bcui19
Copy link
Contributor

@bcui19 bcui19 commented Sep 16, 2022

Updating the URLs in docs with the newly generated links.

Remade the PR for CO-965.

I wasn't able to track down a few of the links:

./examples/streaming_dataloader_facesynthetics.ipynb:32: "[streaming_dataset]: https://docs.mosaicml.com/en/stable/api_reference/composer.datasets.streaming.dataset.html#composer.datasets.streaming.dataset.StreamingDataset\n”,

./examples/streaming_dataloader_facesynthetics.ipynb:33: "[streaming_dataset_writer]: https://docs.mosaicml.com/en/stable/api_reference/composer.datasets.streaming.writer.html#composer.datasets.streaming.writer.StreamingDatasetWriter”

./examples/streaming_dataloader_facesynthetics.ipynb:268: "[api]: https://docs.mosaicml.com/en/stable/api_reference/composer.datasets.streaming.writer.html#composer.datasets.streaming.writer.StreamingDatasetWriter"

./examples/streaming_dataloader_facesynthetics.ipynb:326: "For more information on the StreamingDataset parent class check out the API reference."

./examples/glue/glue_entrypoint.ipynb:115: "[trainer_hparams]: https://docs.mosaicml.com/en/stable/api_reference/composer.trainer.trainer_hparams.html?highlight=trainerhparams#composer.trainer.trainer_hparams.TrainerHparams\n"

Let me know what would be good to do with the above links.

Copy link
Contributor

@dblalock dblalock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM other than one typo. I manually checked all the changed URLs (changing stable to latest to preview how they'll show up in the next release). I didn't check whether there are other broken links in the docs--just gonna assume this got them all and we can fix it later if we find more.

As far as the stuff you couldn't find URLs for: the Streaming dataset links can't be fixed until the Streaming V2 docs get written. And YAHP is getting removed / that whole tutorial will need a lot of refactoring, so that one is probably fine. Would be great if you could open a JIRA issue documenting that these links still need to get fixed so we don't lose track of this.

@bcui19 bcui19 merged commit a36c3d7 into mosaicml:dev Sep 19, 2022
bandish-shah pushed a commit to bandish-shah/composer that referenced this pull request Sep 19, 2022
* Fixed references

* Fixing typo

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

Co-authored-by: Hanlin Tang <[email protected]>
Co-authored-by: dblalock <[email protected]>
bcui19 added a commit to bcui19/composer that referenced this pull request Sep 22, 2022
* Fixed references

* Fixing typo

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

Co-authored-by: Hanlin Tang <[email protected]>
Co-authored-by: dblalock <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants