Skip to content

Commit

Permalink
Improve examples documentation (#1188)
Browse files Browse the repository at this point in the history
Improve examples documentation
  • Loading branch information
ajindal1 authored Jan 15, 2025
1 parent 014c5f6 commit 53b939a
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ See documentation at https://onnxruntime.ai/docs/genai.

## Installation

See https://onnxruntime.ai/docs/genai/howto/install
See [installation instructions](https://onnxruntime.ai/docs/genai/howto/install) or [build from source](https://onnxruntime.ai/docs/genai/howto/build-from-source.html)

## Sample code for Phi-3 in Python

Expand Down
6 changes: 3 additions & 3 deletions examples/python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

## Install ONNX Runtime GenAI

Install the python package according to the [installation instructions](https://onnxruntime.ai/docs/genai/howto/install).
Install the python package according to the [installation instructions](https://onnxruntime.ai/docs/genai/howto/install) or [build from source](https://onnxruntime.ai/docs/genai/howto/build-from-source.html).

## Get the model

You can generate the model using the model builder with this library, or bring your own model.
You can generate the model using the model builder with this library, download the model from huggingface ([example](https://github.com/microsoft/onnxruntime-genai?tab=readme-ov-file#sample-code-for-phi-3-in-python)), or bring your own model.

If you bring your own model, you need to provide the configuration. See the [config reference](https://onnxruntime.ai/docs/genai/reference/config).

Expand All @@ -18,7 +18,7 @@ To generate the model with model builder:
pip install numpy transformers torch onnx onnxruntime
```

2. Choose a model. Examples of supported ones are listed on the repo's main README.
2. Choose a model. Examples of supported ones are listed on the repo's main [README](../../README.md).

3. Run the model builder to export, optimize, and quantize the model. More details can be found [here](../../src/python/py/models/README.md)

Expand Down

0 comments on commit 53b939a

Please sign in to comment.