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.

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

Add all datamodules to documentation using sphinx docs-auto-generation #685

Closed
9 tasks done
sugatoray opened this issue Jul 7, 2021 · 5 comments
Closed
9 tasks done
Labels
documentation Improvements or additions to documentation

Comments

@sugatoray
Copy link
Contributor

sugatoray commented Jul 7, 2021

📚 Documentation

At present most of the following datamodules are available under Vision Datamodule in the documentation. However, this is not visible to the user from the sidebar. Neither it is available from the Datmodule documentation, as links directing to each of the Datamodules below.

In other words, there should be at least a single point of entry (perhaps in Datamodule in the docs) where the user should be able to find links to all the datamodules directly.

  • BinaryMNISTDataModule
  • CIFAR10DataModule
  • CityscapesDataModule
  • FashionMNISTDataModule
  • ImagenetDataModule
  • KittiDataModule
  • MNISTDataModule
  • SSLImagenetDataModule
  • STL10DataModule

[EDIT]: The original description of this issue has been updated.

image

What could be helpful?

Here is an example from torchvision.models. A list of models available like this makes it easier for the user to navigate to the relevant docs page. Similarly, a list of datamodules (perhaps in datamodules.rst) pointing to their respective documentation (be it in Vision Datamodules or Sklearn Datamodules), will be very helpful.

image

@sugatoray sugatoray added the documentation Improvements or additions to documentation label Jul 7, 2021
@github-actions
Copy link

github-actions bot commented Jul 7, 2021

Hi! thanks for your contribution!, great first issue!

@sugatoray sugatoray mentioned this issue Jul 7, 2021
21 tasks
@akihironitta
Copy link
Contributor

@sugatoray Could you elaborate on why we need this? We already have the docs for datamodules here.

@sugatoray
Copy link
Contributor Author

@sugatoray Could you elaborate on why we need this? We already have the docs for datamodules here.

@akihironitta Thank you for pointing me to the docs for Vision Module. However, after looking at it I changed the issue description. It will be nice to be able to see all the datamodules easily accessible from a single point of entry: either from the sidebar or from here: https://lightning-bolts.readthedocs.io/en/latest/, or (preferably) both. Please see the updated issue description.

sugatoray added a commit to sugatoray/lightning-bolts that referenced this issue Jul 11, 2021
@stale
Copy link

stale bot commented Sep 6, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the won't fix This will not be worked on label Sep 6, 2021
@sugatoray
Copy link
Contributor Author

This issue should be closed as it was taken care of already.

@stale stale bot removed the won't fix This will not be worked on label Sep 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants