Warning, /AID2E-framework/docs/getting-started/quick-start.md is written in an unsupported language. File is not indexed.
0001 # Quick Start
0002
0003 Follow the [installation guide](installation.md), then run the following commands from the repository root. Confirm that the `aid2e` command is available:
0004
0005 ```bash
0006 aid2e version
0007 aid2e --help
0008 ```
0009
0010 ## Review the Example Configuration
0011
0012 The DTLZ2 example is a full configuration with an optimizer (Ax), a scheduler (JobLib), and an inline objective evaluator:
0013
0014 ```bash
0015 aid2e describe examples/dtlz2/configurations/dtlz2_ax_joblib.yml
0016 ```
0017
0018 ## Validate the Configuration
0019
0020 Validate the complete optimization configuration without executing it:
0021
0022 ```bash
0023 aid2e optimize examples/dtlz2/configurations/dtlz2_ax_joblib.yml --validate-only
0024 ```
0025
0026 ## Run the Optimization
0027
0028 ```bash
0029 aid2e optimize examples/dtlz2/configurations/dtlz2_ax_joblib.yml
0030 ```
0031
0032 For this Ax example, `n_iterations` controls the total number of trial evaluations:
0033
0034 ```yaml
0035 optimizer:
0036 parameters:
0037 n_iterations: 100
0038 ```
0039
0040 Reduce `n_iterations` for a shorter initial run. The optimizer, scheduler, and their parameters can be changed in the same configuration.
0041
0042 ## Review the Results
0043
0044 Each run creates a directory under:
0045
0046 ```text
0047 examples/dtlz2/configurations/output/ax_joblib/<run-id>/
0048 ```
0049
0050 The primary outputs are `optimization_results.json` and `pareto_front.json`.
0051
0052 See the [CLI guide](../user-guide/cli.md) for configuration inspection, workflow selection, output overrides, logging, and other commands.
