Skip to content

Commit

Permalink
doc (#146)
Browse files Browse the repository at this point in the history
chore: Update benchmark script

Co-authored-by: William Blum <[email protected]>
  • Loading branch information
blumu and William Blum authored Aug 7, 2024
1 parent 8f7078c commit a038334
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 2 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ Read the [Quick introduction](/docs/quickintro.md) to the project.

## Benchmark

See [Benchmark](/docs/benchmark.md).
See [Benchmark documentation](/docs/benchmark.md).
Jupyter notebooks with the latest runs are checked-in under a dedicated tag at [/notebooks/benchmarks (latest_benchmark)](https://github.com/microsoft/CyberBattleSim/tree/latest_benchmark/notebooks/benchmarks).

## Setting up a dev environment

Expand Down
4 changes: 3 additions & 1 deletion docs/benchmark.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Benchmark on baseline agent implementations

Results obtained on envrionment `CyberBattleChain10` using several algorithms: purely random search, Q-learning with epsilon-greedy, exploiting learned matrix only.
Results obtained on envrionment `CyberBattleChain10` using following algorithms: purely random search, Q-learning with epsilon-greedy, exploiting learned matrix only.

Jupyter notebooks with the latest benchmark runs are available at [/notebooks/benchmarks (latest_benchmark)](https://github.com/microsoft/CyberBattleSim/tree/latest_benchmark/notebooks/benchmarks).

## Time to full ownership on `chain` network environment

Expand Down
31 changes: 31 additions & 0 deletions notebooks/run_benchmark.sh
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,36 @@ run notebook_benchmark-chain -y "
plots_dir: $output_plot_dir
"

run notebook_benchmark-toyctf -y "
plots_dir: $output_plot_dir
"

run notebook_benchmark-chain -y "
plots_dir: $output_plot_dir
"

run notebook_benchmark-tiny -y "
plots_dir: $output_plot_dir
"

run notebook_dql_transfer -y "
plots_dir: $output_plot_dir
"

run notebook_randlookups -y "
plots_dir: $output_plot_dir
"""

run notebook_tabularq -y "
plots_dir: $output_plot_dir
"

run notebook_withdefender -y "
plots_dir: $output_plot_dir
"

run dql_active_directory -y "
iteration_count: 50
"

popd

0 comments on commit a038334

Please sign in to comment.