0.5.0 release docs #662
0.5.0 release docs #662
Conversation
docs/source/datasets.rst
Outdated
|
|
||
| .. currentmodule:: torchtext.datasets | ||
|
|
||
| TorchText datasets. |
There was a problem hiding this comment.
How is this going to be rendered? Is this meant to be a title?
There was a problem hiding this comment.
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.
nit: is there an empty space at the end? :)
|
|
||
| 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.
nit: Have you double checked how this extra space renders?
There was a problem hiding this comment.
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.
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.
Added to the docs
| torchtext.legacy.datasets | ||
| ==================== | ||
|
|
||
| .. currentmodule:: torchtext.legacy.datasets |
There was a problem hiding this comment.
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.
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.
Does this file give enough information about older datasets?
There was a problem hiding this comment.
Add release note.
Update docs for Release 0.5.0. Need to bump up the version number later.