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

Readme update #30

Open
esnvidia opened this issue Oct 17, 2023 · 5 comments
Open

Readme update #30

esnvidia opened this issue Oct 17, 2023 · 5 comments
Assignees
Labels
enhancement New feature or request non-stale

Comments

@esnvidia
Copy link

This install: pip install -U --extra-index-url https://pypi.ngc.nvidia.com triton-model-navigator[<extras,>]

breaks pips parser.

This works instead:

pip install -U --extra-index-url https://pypi.ngc.nvidia.com triton-model-navigator[extras]

@jkosek
Copy link
Collaborator

jkosek commented Oct 17, 2023

Hi @esnvidia!

The command you are mentioning is just an example how to use extras during pip installation.

We may need to enhance the instruction to be more clear. To give an example the following installation commands could be used based on model framework:

  1. PyTorch
pip install -U --extra-index-url https://pypi.ngc.nvidia.com triton-model-navigator
  1. TensorFlow
pip install -U --extra-index-url https://pypi.ngc.nvidia.com triton-model-navigator[tensorflow]
  1. JAX
pip install -U --extra-index-url https://pypi.ngc.nvidia.com triton-model-navigator[jax]

Let us know if this explain reported problem. Thanks!

@esnvidia
Copy link
Author

Hi @jkosek!
Yes, it does, however, I should have been more clear in my request. I simply meant to update the readme to be clearer on the options and ensure that it is able to be copied direct to the terminal.

@jkosek
Copy link
Collaborator

jkosek commented Oct 17, 2023

This is great feedback! Thanks for pointing that @esnvidia.

Copy link

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@github-actions github-actions bot added the Stale label Dec 17, 2023
@jkosek jkosek self-assigned this Dec 20, 2023
@jkosek jkosek added enhancement New feature or request non-stale and removed Stale labels Dec 20, 2023
@jkosek
Copy link
Collaborator

jkosek commented Mar 22, 2024

The docs have been improved. Now the installation is described as mentioned above in the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request non-stale
Development

No branches or pull requests

2 participants