model_navigator icon indicating copy to clipboard operation
model_navigator copied to clipboard

Readme update

Open esnvidia opened this issue 1 year ago • 5 comments

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]

esnvidia avatar Oct 17 '23 00:10 esnvidia

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!

jkosek avatar Oct 17 '23 09:10 jkosek

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.

esnvidia avatar Oct 17 '23 14:10 esnvidia

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

jkosek avatar Oct 17 '23 14:10 jkosek

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[bot] avatar Dec 17 '23 01:12 github-actions[bot]

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

jkosek avatar Mar 22 '24 20:03 jkosek