Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.rst #7175

Merged
merged 5 commits into from
Aug 8, 2023
Merged

Update README.rst #7175

merged 5 commits into from
Aug 8, 2023

Conversation

fayejf
Copy link
Collaborator

@fayejf fayejf commented Aug 6, 2023

What does this PR do ?

update readme regarding container version and python version

Collection: [Note which collection this PR will affect]

Changelog

  • Add specific line by line info of high level changes in this PR.

Usage

  • You can potentially add a usage example below
# Add a code snippet demonstrating how to use this 

Before your PR is "Ready for review"

Pre checks:

  • Make sure you read and followed Contributor guidelines
  • Did you write any new necessary tests?
  • Did you add or update any necessary documentation?
  • Does the PR affect components that are optional to install? (Ex: Numba, Pynini, Apex etc)
    • Reviewer: Does the PR have correct import guards for all optional libraries?

PR Type:

  • New Feature
  • Bugfix
  • Documentation

If you haven't finished some of the above items you can still open "Draft" PR.

Who can review?

Anyone in the community is free to review the PR once the checks have passed.
Contributor guidelines contains specific people who can review PRs to various areas.

Additional Information

  • Related to # (issue)

Signed-off-by: fayejf <[email protected]>
@fayejf fayejf requested review from titu1994 and ericharper August 6, 2023 22:57
titu1994
titu1994 previously approved these changes Aug 7, 2023
Copy link
Collaborator

@titu1994 titu1994 left a comment

Choose a reason for hiding this comment

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

This looks good !

Copy link
Collaborator

@XuesongYang XuesongYang left a comment

Choose a reason for hiding this comment

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

Thanks for the update! Besides these changes, I guess we have to update ones to display correct info in PyPi repository. For example, we may need to change below,

  1. https://github.com/NVIDIA/NeMo/blob/main/setup.py#L216-L219;
  2. https://github.com/NVIDIA/NeMo/blob/main/pyproject.toml#L19

@fayejf
Copy link
Collaborator Author

fayejf commented Aug 8, 2023

Thanks for the update! Besides these changes, I guess we have to update ones to display correct info in PyPi repository. For example, we may need to change below,

  1. https://github.com/NVIDIA/NeMo/blob/main/setup.py#L216-L219;
  2. https://github.com/NVIDIA/NeMo/blob/main/pyproject.toml#L19

Make sense. Thanks for pointing out. Updating.

@fayejf
Copy link
Collaborator Author

fayejf commented Aug 8, 2023

Updated the pypi and this will be reflected when @ericharper build next release. I'm not familier with this part please let me know if I missed anything.

Just wondering do we need to strctly limit user to use python3.10? such as updating here
I think NeMo is fine with python 3.9 so I didn't change here.

please review @XuesongYang @titu1994 @ericharper

@titu1994
Copy link
Collaborator

titu1994 commented Aug 8, 2023

Probably best to update it to 3.10+ everywhere so that it gets tested more

titu1994
titu1994 previously approved these changes Aug 8, 2023
@@ -217,6 +217,7 @@ def finalize_options(self):
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9',
'Programming Language :: Python :: 3.10',
Copy link
Collaborator

Choose a reason for hiding this comment

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

Let's remove 3.8 from the above ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

updated.

Signed-off-by: fayejf <[email protected]>
@fayejf
Copy link
Collaborator Author

fayejf commented Aug 8, 2023

Probably best to update it to 3.10+ everywhere so that it gets tested more

Please approve again. The reason I hesitate to update to 3.10+ everywhere is I doubt phuoc was testing with 3.10. It's better to ask him to QA test on 3.10 in next release in case anything breaks.

@@ -215,8 +215,8 @@ def finalize_options(self):
'License :: OSI Approved :: Apache Software License',
# Supported python versions
'Programming Language :: Python :: 3',
Copy link
Collaborator

Choose a reason for hiding this comment

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

do we want to keep this?

Copy link
Collaborator

@XuesongYang XuesongYang left a comment

Choose a reason for hiding this comment

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

Thanks! LGTM. rotating to @titu1994 and @ericharper for a final walk through.

Copy link
Collaborator

@ericharper ericharper left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks!

@fayejf fayejf merged commit f0f3ceb into main Aug 8, 2023
@fayejf fayejf deleted the update_readme branch August 8, 2023 20:52
dorotat-nv pushed a commit to dorotat-nv/NeMo that referenced this pull request Aug 24, 2023
* Update README.rst

Signed-off-by: fayejf <[email protected]>

* Update setup.py

Signed-off-by: fayejf <[email protected]>

* Update pyproject.toml

Signed-off-by: fayejf <[email protected]>

* Update setup.py

Signed-off-by: fayejf <[email protected]>

---------

Signed-off-by: fayejf <[email protected]>
Signed-off-by: dorotat <[email protected]>
rohitrango pushed a commit to rohitrango/NeMo that referenced this pull request Jun 25, 2024
* Update README.rst

Signed-off-by: fayejf <[email protected]>

* Update setup.py

Signed-off-by: fayejf <[email protected]>

* Update pyproject.toml

Signed-off-by: fayejf <[email protected]>

* Update setup.py

Signed-off-by: fayejf <[email protected]>

---------

Signed-off-by: fayejf <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants