# HyperOptimizer Documentation

> Technical documentation for integrating Dockerized workloads with HyperOptimizer — CLI parameters, metrics output, and integration guides for trading backtests and other containerized workloads.

## Usage Policy

HyperOptimizer allows crawling, indexing, search, summarization, retrieval-augmented generation, and AI assistant input/use of this content. HyperOptimizer does not allow use of this content to train, fine-tune, or otherwise improve machine learning or AI models.

## Guides

- [Introduction](https://docs.hyperoptimizer.com): How HyperOptimizer works, your role vs ours, and links to all guides.
- [Quickstart](https://docs.hyperoptimizer.com/quickstart): Package your app in Docker, parse `--hpo-*` CLI args, and print metrics as `hpo.metrics.<key>=<json-encoded-value>`.
- [Freqtrade integration](https://docs.hyperoptimizer.com/integrations/freqtrade): Wrap Freqtrade backtests — parse HPO args, run `freqtrade backtesting`, emit metrics to stdout.
- [NautilusTrader integration](https://docs.hyperoptimizer.com/integrations/nautilus-trader): Wrap Nautilus backtests — parse HPO args, run the engine, emit metrics to stdout.

## Integration Contract

HyperOptimizer runs your Docker container once per trial with different `--hpo-*` command-line arguments (chosen by Bayesian optimization). Your program must:

1. Parse `--hpo-*` arguments in your code (e.g. with `argparse`).
2. Run the workload non-interactively (training, backtest, simulation, etc.).
3. Print each metric to stdout: `hpo.metrics.<key>=<json.dumps(value)>`.

Example output:

```
hpo.metrics.sharpe=1.85
hpo.metrics.max_drawdown=0.12
```

No SDK or client library is required. Trials run in parallel (5 by default) in isolated containers.

## Product & Access

- [Product overview](https://hyperoptimizer.com/product): How HyperOptimizer works — Bayesian optimization, parallel trials, dashboard results.
- [Docker integration](https://hyperoptimizer.com/product/docker): Docker-native optimization for any language or framework.
- [Private beta](https://hyperoptimizer.com/beta): Join the waitlist for managed optimization infrastructure.
- [Contact](https://hyperoptimizer.com/contact): Integration questions and support.

## Related Discovery

- Main site llms.txt: https://hyperoptimizer.com/llms.txt
- Agent discovery index: https://hyperoptimizer.com/.well-known/agents/index.json
- API catalog: https://hyperoptimizer.com/.well-known/api-catalog