Skip to content

Commit

Permalink
Merge pull request #2557 from jeffng-or/at-doc-update2
Browse files Browse the repository at this point in the history 
separated tuner-specific args into their own section + message typo
  • Loading branch information
@maliberty
maliberty authored Nov 13, 2024
2 parents 5e33163 + 0da9878 commit 60c85c4
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 30 deletions.
67 changes: 38 additions & 29 deletions docs/user/InstructionsForAutoTuner.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -154,35 +154,44 @@ GCP Setup Tutorial coming soon.


### List of input arguments
| Argument | Description |
|-------------------------------|-------------------------------------------------------------------------------------------------------|
| `--design` | Name of the design for Autotuning. |
| `--platform` | Name of the platform for Autotuning. |
| `--config` | Configuration file that sets which knobs to use for Autotuning. |
| `--experiment` | Experiment name. This parameter is used to prefix the FLOW_VARIANT and to set the Ray log destination.|
| `--resume` | Resume previous run. |
| `--git_clean` | Clean binaries and build files. **WARNING**: may lose previous data. |
| `--git_clone` | Force new git clone. **WARNING**: may lose previous data. |
| `--git_clone_args` | Additional git clone arguments. |
| `--git_latest` | Use latest version of OpenROAD app. |
| `--git_or_branch` | OpenROAD app branch to use. |
| `--git_orfs_branch` | OpenROAD-flow-scripts branch to use. |
| `--git_url` | OpenROAD-flow-scripts repo URL to use. |
| `--build_args` | Additional arguments given to ./build_openroad.sh |
| `--algorithm` | Search algorithm to use for Autotuning. |
| `--eval` | Evaluate function to use with search algorithm. |
| `--samples` | Number of samples for tuning. |
| `--iterations` | Number of iterations for tuning. |
| `--resources_per_trial` | Number of CPUs to request for each tuning job. |
| `--reference` | Reference file for use with PPAImprov. |
| `--perturbation` | Perturbation interval for PopulationBasedTraining |
| `--seed` | Random seed. |
| `--jobs` | Max number of concurrent jobs. |
| `--openroad_threads` | Max number of threads usable. |
| `--server` | The address of Ray server to connect. |
| `--port` | The port of Ray server to connect. |
| `-v` or `--verbose` | Verbosity Level. [0: Only ray status, 1: print stderr, 2: print stdout on top of what is in level 0 and 1. ] |
| | |
| Argument | Description | Default |
|-------------------------------|-------------------------------------------------------------------------------------------------------|---------|
| `--design` | Name of the design for Autotuning. ||
| `--platform` | Name of the platform for Autotuning. ||
| `--config` | Configuration file that sets which knobs to use for Autotuning. ||
| `--experiment` | Experiment name. This parameter is used to prefix the FLOW_VARIANT and to set the Ray log destination.| test |
| `--git_clean` | Clean binaries and build files. **WARNING**: may lose previous data. ||
| `--git_clone` | Force new git clone. **WARNING**: may lose previous data. ||
| `--git_clone_args` | Additional git clone arguments. ||
| `--git_latest` | Use latest version of OpenROAD app. ||
| `--git_or_branch` | OpenROAD app branch to use. ||
| `--git_orfs_branch` | OpenROAD-flow-scripts branch to use. ||
| `--git_url` | OpenROAD-flow-scripts repo URL to use. | [ORFS GitHub repo](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts) |
| `--build_args` | Additional arguments given to ./build_openroad.sh ||
| `--samples` | Number of samples for tuning. | 10 |
| `--jobs` | Max number of concurrent jobs. | # of CPUs / 2 |
| `--openroad_threads` | Max number of threads usable. | 16 |
| `--server` | The address of Ray server to connect. ||
| `--port` | The port of Ray server to connect. | 10001 |
| `--timeout` | Time limit (in hours) for each trial run. | No limit |
| `-v` or `--verbose` | Verbosity Level. [0: Only ray status, 1: print stderr, 2: print stdout on top of what is in level 0 and 1. ] | 0 |
| | ||

#### Input arguments specific to tune mode
The following input arguments are applicable for tune mode only.

| Argument | Description | Default |
|-------------------------------|-------------------------------------------------------------------------------------------------------|---------|
| `--algorithm` | Search algorithm to use for Autotuning. | hyperopt |
| `--eval` | Evaluate function to use with search algorithm. ||
| `--iterations` | Number of iterations for tuning. | 1 |
| `--resources_per_trial` | Number of CPUs to request for each tuning job. | 1 |
| `--reference` | Reference file for use with PPAImprov. ||
| `--perturbation` | Perturbation interval for PopulationBasedTraining | 25 |
| `--seed` | Random seed. | 42 |
| `--resume` | Resume previous run. ||
| | ||

### GUI

Basically, progress is displayed at the terminal where you run, and when all runs are finished, the results are displayed.
Expand Down
2 changes: 1 addition & 1 deletion tools/AutoTuner/src/autotuner/distributed.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -789,7 +789,7 @@ def parse_arguments():
type=int,
metavar="<int>",
default=1,
help="Number of CPUs to request for each tunning job.",
help="Number of CPUs to request for each tuning job.",
)
tune_parser.add_argument(
"--reference",
Expand Down

0 comments on commit 60c85c4

Please sign in to comment.