-
Notifications
You must be signed in to change notification settings - Fork 813
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
0.5.0 release docs #662
0.5.0 release docs #662
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Have you tested how it renders on your computer? Do you have some screenshots?
See a few comments, but overall LGTM.
docs/source/datasets.rst
Outdated
|
||
.. currentmodule:: torchtext.datasets | ||
|
||
TorchText datasets. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How is this going to be rendered? Is this meant to be a title?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's just a text. Not title. I will remove it.
docs/source/datasets.rst
Outdated
|
||
Sentiment Analysis | ||
^^^^^^^^^^^^^^^^^^ | ||
|
||
SST | ||
~~~ | ||
|
||
.. autoclass:: SST | ||
.. autoclass:: SST |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: is there an empty space at the end? :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
|
||
The following datasets are re-writed and more compatible with ``torch.utils.data``. General use cases are as follows: :: | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Have you double checked how this extra space renders?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. I have generated the HTML files and it looks fine.
|
||
.. currentmodule:: torchtext.experimental.datasets | ||
|
||
The following datasets are re-writed and more compatible with ``torch.utils.data``. General use cases are as follows: :: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: do you mean "The following datasets have been rewritten and interact better with torch.utils.data
. Here is an example:"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added to the docs
torchtext.legacy.datasets | ||
==================== | ||
|
||
.. currentmodule:: torchtext.legacy.datasets |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is the documentation for older datasets completely gone? (unless docs/source/examples.rst
covers this?) Is that intentional?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There won't be any datasets in the legacy folder. The new datasets are not in experimental folder and the old datasets are in the original place. So I delete the legacy folder.
docs/source/examples.rst
Outdated
@@ -4,6 +4,8 @@ | |||
Examples | |||
========= | |||
|
|||
Note: We are working on new building blocks and datasets. Some of the components in the examples (e.g. Field) will eventually retire. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this file give enough information about older datasets?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add release note.
Update docs for Release 0.5.0. Need to bump up the version number later.