Skip to content

Optimizer doc fix #884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 1, 2025
Merged

Optimizer doc fix #884

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f777a0c
Update output descriptions in email phishing analyzer README
dnandakumar-nv Oct 1, 2025
9be87ed
Update output descriptions in email phishing analyzer README
dnandakumar-nv Oct 1, 2025
11d3765
Fix inconsistent bullet point formatting in README
dnandakumar-nv Oct 1, 2025
87f7396
"Clarify output file naming in README"
dnandakumar-nv Oct 1, 2025
11e3d16
"Clarify output file naming in README"
dnandakumar-nv Oct 1, 2025
b235765
Standardize "Pareto" capitalization across documentation.
dnandakumar-nv Oct 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions ci/vale/styles/config/vocabularies/nat/accept.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ onboarding
[Oo]verfitting
pandas
[Pp]arallelization
Pareto
[Pp]arsable
Patronus
PCIe
Expand Down
12 changes: 8 additions & 4 deletions examples/evaluation_and_profiling/email_phishing_analyzer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,10 +206,14 @@ Ensure `NVIDIA_API_KEY` is set in your environment.

### Outputs
Results are written to the path specified by `optimizer.output_path`. Expect artifacts such as:
- `best_params.json`: Highest-scoring parameter set.
- `optimization_results.json`: Per-trial metrics and parameters.
- `pareto_front.png`, `optimization_history.png`, `param_importances.png`: Visual summaries.
- For prompt optimization (when enabled): `optimized_prompts.json` and per-generation prompt history.
- `optimized_config.yml`: Tuned configuration derived from the selected trial.
- You will also see a configuration file for each iteration of numeric trials. For example, `config_numeric_trial_0.yml`
will contain the configuration for the first numeric trial. This is helpful for selecting specific trials whose metrics
you may prefer to the optimizer selected trial.
- `trials_dataframe_params.csv`: Full Optuna trials `dataframe` (`values`, `params`, `timings`, `rep_scores`).
- `plots`: This directory will contain Pareto visualizations of the optimization results.
- For prompt optimization (when enabled): `optimized_prompts.json` and per-generation prompt history. Per generation prompt
history files are named `optimized_prompts_gen{N}.json` where `{N}` is the generation number starting from 1.

---

Expand Down