Update README file for 0.9.0 release #1198
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1198 +/- ##
=======================================
Coverage 73.23% 73.23%
=======================================
Files 67 67
Lines 3718 3718
=======================================
Hits 2723 2723
Misses 995 995 Continue to review full report at Codecov.
|
torchtext/legacy/README.rst
Outdated
| * ``torchtext.legacy.data.pipeline`` | ||
| * ``torchtext.legacy.datasets`` | ||
|
|
||
| We have a `migration tutorial <https://fburl.com/9hbq843y>`_ to help users switch to the torchtext datasets in ``v0.9.0`` release. For the users who still want the legacy components, they can add ``legacy`` to the import path. |
There was a problem hiding this comment.
You can export a colab notebook as an ipython notebook and upload the ipython notebook here.
Then you can create a colab link that uses the ipython on github like so:
https://colab.research.google.com/github/pytorch/nestedtensor/blob/master/tutorials/notebooks/basic.ipynb
There was a problem hiding this comment.
Move the tutorial to examples/migration_tutorial folder and it's also available as https://colab.research.google.com/github/zhangguanheng66/text/blob/migration_tutorial/examples/legacy_tutorial/migration_tutorial.ipynb
zhangguanheng66
force-pushed
the
README
branch
from
a89551b
to
7f653c5
Compare
| pip install --pre torch torchtext -f https://download.pytorch.org/whl/nightly/cpu/torch_nightly.html | ||
|
|
||
| For more detailed instructions, please refer to `Install PyTorch <https://pytorch.org/get-started/locally/>`_. It should be noted that the new building blocks are still under development, and the APIs have not been solidified. | ||
| Note: the legacy code discussed in `torchtext v0.7.0 release note <https://github.com/pytorch/text/releases/tag/v0.7.0-rc3>`_ has been retired to `torchtext.legacy <#legacy>`_ folder. Those legacy code will not be maintained by the development team, and we plan to fully remove them in the future release. See the Legacy session for more details. | ||
|
|
||
| Installation |
There was a problem hiding this comment.
In line below, I think Anaconda is not the package manager but is more like a distribution whereas conda is the underlying package manager. Should we rephrase it to something like: "We recommend conda as package manager that comes with Anaconda or miniconda"?
There was a problem hiding this comment.
Here we are using the consistent statement on PyTorch website: "Anaconda is our recommended package manager..." - link
There was a problem hiding this comment.
Sure, we can probably leave it as such then to keep the consistency with PyTorch as this is a minor technical detail that users won't mind :)
@cpuhrsch Just FYI
| Others are planned or a work in progress: | ||
| * Transforms | ||
| * Vocabulary | ||
| * Vectors | ||
|
|
There was a problem hiding this comment.
Should we provide short note or one liner description of each of "Transforms", "Vocabulary" and "Vectors". Or at-least a link where users can learn more about it? Since these are prototype features where we probably want some feedback, users might want to learn about them quickly through somewhere?
There was a problem hiding this comment.
Sure. Let me add those links and some descriptions.
No description provided.