Skip to content

Commit

Permalink
Add options document (#1566)
Browse files Browse the repository at this point in the history
## Describe your changes

- Add options page.
- Update document for recent changes.
- Rename `API reference` to `Reference`.
- Remove Engine, Metrics, Evaluators, Resource Path API page.
- Remove advanced users page.
- Add subsections to Pass page.

## Checklist before requesting a review
- [ ] Add unit tests for this change.
- [ ] Make sure all tests can pass.
- [ ] Update documents if necessary.
- [ ] Lint and apply fixes to your code by running `lintrunner -a`
- [ ] Is this a user-facing change? If yes, give a description of this
change to be included in the release notes.
- [ ] Is this PR including examples changes? If yes, please remember to
update [example
documentation](https://github.com/microsoft/Olive/blob/main/docs/source/examples.md)
in a follow-up PR.

## (Optional) Issue link
  • Loading branch information
xiaoyu-work authored Jan 24, 2025
1 parent fb0d228 commit 0b46917
Show file tree
Hide file tree
Showing 16 changed files with 720 additions and 478 deletions.
131 changes: 0 additions & 131 deletions docs/source/extending/advanced-users.md

This file was deleted.

8 changes: 0 additions & 8 deletions docs/source/extending/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,10 @@ Extending Olive

:octicon:`arrow-right;1em;sd-text-info` `Custom scripts <custom-scripts.html>`_

.. grid-item-card::
**Advanced users**

Learn how to use Olive as a library and extend it for your own use cases.

:octicon:`arrow-right;1em;sd-text-info` `Advanced users <advanced-users.html>`_

.. toctree::
:maxdepth: 2
:hidden:

design
how-to-add-optimization-pass
custom-scripts
advanced-users
2 changes: 1 addition & 1 deletion docs/source/how-to/cli/cli-run.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The *output* of the workflow is a Zip file containing the ONNX model and ORT con

### {octicon}`code-square` Define the workflow in a YAML file

First, define the "quickstart workflow" in a YAML file:
First, define the 'quickstart workflow' in a YAML file. Alternatively, you can use a JSON file. For more details about the available options for the configuration file, please refer to this [reference](../../reference/options.md):

```yaml
# quickstart-workflow.yaml
Expand Down
38 changes: 38 additions & 0 deletions docs/source/how-to/configure-workflows/systems.md
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,44 @@ There are some readymade systems available for AzureML. These systems are pre-co
}
```

System alias list:

- AzureND12SSystem:
- sku: "STANDARD_ND12S"
- num_cpus: 12
- num_gpus: 2

- AzureND24RSSystem:
- sku: "STANDARD_ND24RS"
- num_cpus: 24
- num_gpus: 4

- AzureND24SSystem:
- sku: "STANDARD_ND24S"
- num_cpus: 24
- num_gpus: 4

- AzureNDV2System:
- sku: "STANDARD_ND40RS_V2"
- num_cpus: 40
- num_gpus: 8

- AzureND6SSystem:
- sku: "STANDARD_ND6S"
- num_cpus: 6
- num_gpus: 1

- AzureND96A100System:
- sku: "STANDARD_ND96AMSR_A100_V4"
- num_cpus: 96
- num_gpus: 8

- AzureND96ASystem:
- sku: "STANDARD_ND96ASR_V4"
- num_cpus: 96
- num_gpus: 8


```{Note}
The accelerators specified in the readymade systems will be filtered against the devices supported by the readymade system. If the specified device is not supported by the readymade system, Olive will filter out the accelerator.
In above example, the readymade system supports only GPU. Therefore, the final accelerators will be ``[{"device": "gpu", "execution_providers": ["CUDAExecutionProvider"]}]`` and the CPU will be filtered out.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
content: "Install `olive-ai` with `pip` and get up and running with OLIVE in minutes.<br/>{octicon}`arrow-right` [Get Started](getting-started/getting-started.md)"
- header: "{octicon}`rocket` How To"
content: "Find more details on specific Olive capabilities, such as quantization, running workflows on remote compute, model packaging, conversions, and more!<br/>{octicon}`arrow-right` [Features](how-to/index)"
- header: "{fas}`code` API Reference"
content: "Get more details on specific Olive capabilities, such as running workflows on remote compute (for example, Azure AI), model packaging, conversions, and more!<br/>{octicon}`arrow-right` [APIs](reference/index)"
- header: "{fas}`code` Reference"
content: "Get more details on specific Olive capabilities, such as running workflows on remote compute (for example, Azure AI), model packaging, conversions, and more!<br/>{octicon}`arrow-right` [Reference](reference/index)"
- header: "{octicon}`diff-added` Extending Olive"
content: "Learn about the design of Olive and how to extend Olive with your own optimization methods.<br/>{octicon}`arrow-right` [Extend Olive](extending/index)"
```
Expand Down
33 changes: 0 additions & 33 deletions docs/source/reference/engine.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/source/reference/evaluator.rst

This file was deleted.

42 changes: 4 additions & 38 deletions docs/source/reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,11 @@ API reference
:octicon:`arrow-right;1em;sd-text-info` `CLI <cli.html>`_

.. grid-item-card::
**Engine**
**Explore Olive configuration options**

Learn about Olive's engine configuration.
Explore Olive configuration options.

:octicon:`arrow-right;1em;sd-text-info` `Engine <engine.html>`_

.. grid-item-card::
**Evaluator**

Details on evaluators available in Olive.

:octicon:`arrow-right;1em;sd-text-info` `Evaluator <evaluator.html>`_

.. grid-item-card::
**Metric**

Learn about metrics configuration.

:octicon:`arrow-right;1em;sd-text-info` `Metric <metric.html>`_
:octicon:`arrow-right;1em;sd-text-info` `Olive options <options.html>`_

.. grid-item-card::
**Model**
Expand All @@ -46,40 +32,20 @@ API reference

:octicon:`arrow-right;1em;sd-text-info` `Pass <pass.html>`_

.. grid-item-card::
**Resource Path**

Manage and configure resource paths.

:octicon:`arrow-right;1em;sd-text-info` `Resource Path <resource-path.html>`_

.. grid-item-card::
**Search Algorithm**

Configure search strategies.

:octicon:`arrow-right;1em;sd-text-info` `Search Algorithm <search-algorithm.html>`_

.. grid-item-card::
**System**

Learn about system settings and configurations.

:octicon:`arrow-right;1em;sd-text-info` `System <system.html>`_




.. toctree::
:maxdepth: 2
:hidden:

cli
engine
evaluator
metric
options
model
pass
resource-path
search-algorithm
system
40 changes: 0 additions & 40 deletions docs/source/reference/metric.rst

This file was deleted.

Loading

0 comments on commit 0b46917

Please sign in to comment.