-
Notifications
You must be signed in to change notification settings - Fork 6.8k
Conversation
Hey @waytrue17 , Thanks for submitting the PR
CI supported jobs: [centos-gpu, centos-cpu, website, sanity, miscellaneous, edge, unix-cpu, unix-gpu, clang, windows-gpu, windows-cpu] Note: |
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.
Can we try and fix the formatting so that the list shows up correctly? It looks ok here:
https://github.com/apache/incubator-mxnet/blob/ea66f6cd6e0f0641aa5054ecc0d31b4a88b3d6d4/tools/pip/doc/CU101_ADDITIONAL.md
but then turns into a jumbled paragraph here: https://pypi.org/project/mxnet-cu101/
Heres the PyPI format info: https://pypi.org/help/#description-content-type
it looks like we set long_description_content_type
here:
https://github.com/apache/incubator-mxnet/blob/a192bcac1f02757c452a9cc947ea44bdd86c213b/tools/pip/setup.py#L182
Using https://pypi.org/project/readme-renderer/ it generates this html:
<h2>Prerequisites</h2>
<p>This package supports Linux and Windows platforms. You may also want to check:
- [mxnet-cu110](<a href="https://pypi.python.org/pypi/mxnet-cu110/" rel="nofollow">https://pypi.python.org/\
pypi/mxnet-cu110/</a>) with CUDA-11.0 support.
- [mxnet-cu102](<a href="https://pypi.python.org/pypi/mxnet-cu102/" rel="nofollow">https://pypi.python.org/\
pypi/mxnet-cu102/</a>) with CUDA-10.2 support.
- [mxnet-cu101](<a href="https://pypi.python.org/pypi/mxnet-cu101/" rel="nofollow">https://pypi.python.org/\
pypi/mxnet-cu101/</a>) with CUDA-10.1 support.
- [mxnet-cu92](<a href="https://pypi.python.org/pypi/mxnet-cu92/" rel="nofollow">https://pypi.python.org/py\
pi/mxnet-cu92/</a>) with CUDA-9.2 support.
- [mxnet](<a href="https://pypi.python.org/pypi/mxnet/" rel="nofollow">https://pypi.python.org/pypi/mxnet/<\
/a>).</p>
adding a newline between the sentence and the list seems to work and generates this html:
<h2>Prerequisites</h2>
<p>This package supports Linux and Windows platforms. You may also want to check:</p>
<ul>
<li>[mxnet-cu110](<a href="https://pypi.python.org/pypi/mxnet-cu110/" rel="nofollow">https://pypi.python.or\
g/pypi/mxnet-cu110/</a>) with CUDA-11.0 support.</li>
<li>[mxnet-cu102](<a href="https://pypi.python.org/pypi/mxnet-cu102/" rel="nofollow">https://pypi.python.or\
g/pypi/mxnet-cu102/</a>) with CUDA-10.2 support.</li>
<li>[mxnet-cu101](<a href="https://pypi.python.org/pypi/mxnet-cu101/" rel="nofollow">https://pypi.python.or\
g/pypi/mxnet-cu101/</a>) with CUDA-10.1 support.</li>
<li>[mxnet-cu92](<a href="https://pypi.python.org/pypi/mxnet-cu92/" rel="nofollow">https://pypi.python.org/\
pypi/mxnet-cu92/</a>) with CUDA-9.2 support.</li>
<li>[mxnet](<a href="https://pypi.python.org/pypi/mxnet/" rel="nofollow">https://pypi.python.org/pypi/mxnet\
/</a>).</li>
</ul>
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.
Thanks @waytrue17 !
* fix pip link for cu100 * add new line Co-authored-by: Wei Chu <weichu@amazon.com>
Description
Fix cu100 pip link
Checklist
Essentials
Changes
Comments