README: add status badges, update extras docs (#612)
## Describe your changes Add status badges for the pipelines so devs can see the most recent status for the pipelines easily. Update the docs for olive extras. ## Checklist before requesting a review - [ ] Add unit tests for this change. - [ ] Make sure all tests can pass. - [ ] Update documents if necessary. - [ ] Format your code by running `pre-commit run --all-files` - [ ] Is this a user-facing change? If yes, give a description of this change to be included in the release notes. ## (Optional) Issue link
This commit is contained in:
Родитель
c27d1f5cf3
Коммит
51271f89d4
14
README.md
14
README.md
|
@ -50,10 +50,16 @@ pip install olive-ai[directml]
|
|||
```
|
||||
|
||||
### Optional Dependencies
|
||||
Olive has optional dependencies that can be installed to enable additional features. These dependencies can be installed as extras:
|
||||
- **azureml**: To enable AzureML integration. Packages: `azure-ai-ml, azure-identity`
|
||||
- **docker**: To enable docker integration. Packages: `docker`
|
||||
- **openvino**: To use OpenVINO related passes. Packages: `openvino==2022.3.0, openvino-dev[tensorflow,onnx]==2022.3.0`
|
||||
Olive has optional dependencies that can be installed to enable additional features. Please refer to [extra dependencies](./olive/extra_dependencies.json) for
|
||||
the list of extras and their dependencies.
|
||||
|
||||
## Pipeline Status
|
||||
|
||||
[![Build Status](https://dev.azure.com/aiinfra/PublicPackages/_apis/build/status%2FOlive%20CI?label=Olive-CI)](https://dev.azure.com/aiinfra/PublicPackages/_build/latest?definitionId=1240)
|
||||
|
||||
[![Build Status](https://dev.azure.com/aiinfra/PublicPackages/_apis/build/status%2FOlive%20Formatting?label=Olive-Formatting)](https://dev.azure.com/aiinfra/PublicPackages/_build/latest?definitionId=1239)
|
||||
|
||||
[![Build Status](https://dev.azure.com/aiinfra/PublicPackages/_apis/build/status%2FOlive-ORT-Nightly?label=Olive-ORT-Nightly)](https://dev.azure.com/aiinfra/PublicPackages/_build/latest?definitionId=1279)
|
||||
|
||||
## Contributing
|
||||
We’d love to embrace your contribution to Olive. Please refer to [CONTRIBUTING.md](./CONTRIBUTING.md).
|
||||
|
|
|
@ -62,7 +62,5 @@ pip install -e .
|
|||
```
|
||||
|
||||
## Optional Dependencies
|
||||
Olive has optional dependencies that can be installed to enable additional features. These dependencies can be installed as extras:
|
||||
- **azureml**: To enable AzureML integration. Packages: `azure-ai-ml, azure-identity`
|
||||
- **docker**: To enable docker integration. Packages: `docker`
|
||||
- **openvino**: To use OpenVINO related passes. Packages: `openvino==2022.3.0, openvino-dev[tensorflow,onnx]==2022.3.0`
|
||||
Olive has optional dependencies that can be installed to enable additional features. Please refer to [extra dependencies](https://github.com/microsoft/Olive/blob/main/olive/extra_dependencies.json)
|
||||
for the list of extras and their dependencies.
|
||||
|
|
Загрузка…
Ссылка в новой задаче