From a03833405cb470d4cdac43b5e4b1b528e4eb0801 Mon Sep 17 00:00:00 2001 From: William Blum Date: Wed, 7 Aug 2024 15:40:18 -0700 Subject: [PATCH] doc (#146) chore: Update benchmark script Co-authored-by: William Blum --- README.md | 3 ++- docs/benchmark.md | 4 +++- notebooks/run_benchmark.sh | 31 +++++++++++++++++++++++++++++++ 3 files changed, 36 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 490c0d1f..547c805b 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/benchmark.md b/docs/benchmark.md index d1be4d58..59bd19f2 100644 --- a/docs/benchmark.md +++ b/docs/benchmark.md @@ -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 diff --git a/notebooks/run_benchmark.sh b/notebooks/run_benchmark.sh index 204f631c..fca54ec4 100755 --- a/notebooks/run_benchmark.sh +++ b/notebooks/run_benchmark.sh @@ -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