Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

[v1.x] Fix cu100 pip link #20084

Merged
merged 2 commits into from
Mar 24, 2021
Merged

[v1.x] Fix cu100 pip link #20084

merged 2 commits into from
Mar 24, 2021

Conversation

waytrue17
Copy link
Contributor

Description

Fix cu100 pip link

Checklist

Essentials

  • PR's title starts with a category (e.g. [BUGFIX], [MODEL], [TUTORIAL], [FEATURE], [DOC], etc)
  • Changes are complete (i.e. I finished coding on this PR)
  • All changes have test coverage
  • Code is well-documented

Changes

  • Feature1, tests, (and when applicable, API doc)
  • Feature2, tests, (and when applicable, API doc)

Comments

  • If this change is a backward incompatible change, why must this change be made.
  • Interesting edge cases to note here

@waytrue17 waytrue17 requested a review from szha as a code owner March 23, 2021 20:25
@mxnet-bot
Copy link

Hey @waytrue17 , Thanks for submitting the PR
All tests are already queued to run once. If tests fail, you can trigger one or more tests again with the following commands:

  • To trigger all jobs: @mxnet-bot run ci [all]
  • To trigger specific jobs: @mxnet-bot run ci [job1, job2]

CI supported jobs: [centos-gpu, centos-cpu, website, sanity, miscellaneous, edge, unix-cpu, unix-gpu, clang, windows-gpu, windows-cpu]


Note:
Only following 3 categories can trigger CI :PR Author, MXNet Committer, Jenkins Admin.
All CI tests must pass before the PR can be merged.

@lanking520 lanking520 added the pr-awaiting-testing PR is reviewed and waiting CI build and test label Mar 23, 2021
@waytrue17 waytrue17 mentioned this pull request Mar 23, 2021
6 tasks
Copy link
Contributor

@samskalicky samskalicky left a 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>

Copy link
Contributor

@samskalicky samskalicky left a comment

Choose a reason for hiding this comment

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

Thanks @waytrue17 !

@lanking520 lanking520 added pr-awaiting-merge Review and CI is complete. Ready to Merge and removed pr-awaiting-testing PR is reviewed and waiting CI build and test labels Mar 23, 2021
@samskalicky samskalicky merged commit 9a00735 into apache:v1.x Mar 24, 2021
samskalicky pushed a commit that referenced this pull request Mar 24, 2021
* fix pip link for cu100

* add new line

Co-authored-by: Wei Chu <weichu@amazon.com>
mseth10 pushed a commit to mseth10/incubator-mxnet that referenced this pull request Mar 24, 2021
* fix pip link for cu100

* add new line

Co-authored-by: Wei Chu <weichu@amazon.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
pr-awaiting-merge Review and CI is complete. Ready to Merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants