Skip to content

Conversation

@vincentqb
Copy link
Contributor

@vincentqb vincentqb commented Jan 8, 2021

Add prototype RNN transducer loss to the documentation. This will need to be guarded off from releases.

Screen Shot 2021-01-11 at 11 48 48 AM

cc #1137

@@ -0,0 +1,21 @@
.. role:: hidden
:class: hidden-section

Copy link
Contributor

Choose a reason for hiding this comment

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

I think it's a good idea to note that prototype is nightly-only feature at the top of all the pages for prototype. So that there is a less chance of receiving the report like this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've labelled the issue as prototype and linked to the "source of truth" definition of prototype, which says "not part of release". Do you mean to say that you feel this may not be clear enough?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, I think we cannot be too careful here.

I suggest add .. note:: or .. warning:: and tell users to use nightly build in a more straightforward manner.

Reading the classification, I feel like it is not even included in nightly build, which is another binary distribution.

Prototype: These features are typically not available as part of binary distributions like PyPI or Conda, except sometimes behind run-time flags, and are at an early stage for feedback and testing.

@vincentqb vincentqb force-pushed the rnntdoc branch 3 times, most recently from b492ec5 to 75cf8e2 Compare January 11, 2021 16:40
Copy link
Contributor

@mthrok mthrok left a comment

Choose a reason for hiding this comment

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

Approving so that you are not blocked, can merge it and see how it is reflected at pytorch.org/audio

After the merge, you can run the nightly job manually from #306 and check how it looks on pytorch.org/audio. If you see an issue, feel free to open a new PR.

@vincentqb vincentqb marked this pull request as ready for review January 11, 2021 20:00
@vincentqb vincentqb merged commit b57f05c into pytorch:master Jan 11, 2021
@vincentqb vincentqb mentioned this pull request Feb 4, 2021
22 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants