Add documentation about carps usage (#157)

* Add documentation about carps usage For the case when developing a standalone package either for a benchmark or for an optimizer. * Update CHANGELOG.md * Add missing word --------- Co-authored-by: Sarah Krebs <[email protected]>
automl · Aug 2, 2024 · 10cfa19 · 10cfa19
1 parent 7338b5b
commit 10cfa19
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,9 @@
 
 # v0.1.1
 
+## Documentation
+- Add example for the case when developing a standalone package either for a benchmark or for an optimizer (#157)
+
 ## Bug Fixes
 - Disallowed HPOBench use in carp-s container, changed HPOBench mode to container mode (#94).
 - Fix HEBO integration (#149).

diff --git a/README.md b/README.md
@@ -158,6 +158,12 @@ guidelines for
 and
 [optimizers](https://automl.github.io/CARP-S/latest/contributing/contributing-an-optimizer/).
 
+## Using your (external) optimizer or benchmark
+In the case when you are developing your optimizer or benchmark in a standalone package, you can use carps without directly working in the carps repo.
+For a custom benchmark we have an [example repo](https://github.com/automl/OptBench).
+It shows how to use your own benchmark with carps optimizers.
+For a custom optimizer check this [example repo](https://github.com/automl/CARP-S-example-optimizer).
+Information is also available [here](https://automl.github.io/CARP-S/guides/using-carps/).
 
 ## Evaluation Results
 For each scenario (blackbox, multi-fidelity, multi-objective and multi-fidelity-multi-objective) and set (dev and test), we run selected optimizers and provide the data.

diff --git a/docs/guides/using-carps.md b/docs/guides/using-carps.md
@@ -0,0 +1,11 @@
+# Using Carps
+
+In the case when you are developing your optimizer or benchmark in a standalone package, you can use carps without directly working in the carps repo.
+
+## With your own benchmark
+For a custom benchmark we have an [example repo](https://github.com/automl/OptBench).
+It shows how to use your own benchmark with carps optimizers.
+
+## With your own optimizer
+When you develop your own optimizer, check this [example repo](https://github.com/automl/CARP-S-example-optimizer).
+It shows how to use your own optimizer with carps benchmarks.
diff --git a/mkdocs.yaml b/mkdocs.yaml
@@ -188,6 +188,7 @@ nav:
     - "guides/database.md"
     - "guides/containers.md"
     - "guides/large-scale-benchmarking.md"
+    - "guides/using-carps.md"
   - Commands: "commands.md"
   - Contributing:
     - "contributing/index.md"