From ab0ad91822ec86dca69b97af54666816981beaf2 Mon Sep 17 00:00:00 2001 From: Brian Kroth Date: Tue, 25 Feb 2025 17:50:40 -0600 Subject: [PATCH] Minor doc tweaks (#956) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit # Pull Request ## Title Minor doc tweaks ______________________________________________________________________ ## Description Minor doc tweaks ______________________________________________________________________ ## Type of Change - 📝 Documentation update ______________________________________________________________________ --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- README.md | 1 + mlos_bench/mlos_bench/config/README.md | 6 ++++++ 2 files changed, 7 insertions(+) diff --git a/README.md b/README.md index a5cdd82ccc6..a8b5de6060d 100644 --- a/README.md +++ b/README.md @@ -198,6 +198,7 @@ See [mlos_bench/config](./mlos_bench/mlos_bench/config/) and [CONTRIBUTING.md](. ### Publications +- [TUNA: Tuning Unstable and Noisy Cloud Applications](http://aka.ms/mlos/tuna-eurosys-paper) at [EuroSys 2025](https://2025.eurosys.org/accepted-papers.html) - [MLOS in Action: Bridging the Gap Between Experimentation and Auto-Tuning in the Cloud](https://www.vldb.org/pvldb/vol17/p4269-kroth.pdf) at [VLDB 2024](https://www.vldb.org/2024/?papers-demo) - [Towards Building Autonomous Data Services on Azure](https://dl.acm.org/doi/abs/10.1145/3555041.3589674) in [SIGMOD Companion 2023](https://dl.acm.org/doi/proceedings/10.1145/3555041) - [LlamaTune: Sample-efficient DBMS configuration tuning](https://www.microsoft.com/en-us/research/publication/llamatune-sample-efficient-dbms-configuration-tuning) at [VLDB 2022](https://vldb.org/pvldb/volumes/15/) diff --git a/mlos_bench/mlos_bench/config/README.md b/mlos_bench/mlos_bench/config/README.md index 86bd682f37f..6e5d58b16f1 100644 --- a/mlos_bench/mlos_bench/config/README.md +++ b/mlos_bench/mlos_bench/config/README.md @@ -8,6 +8,10 @@ In general the `config` directory layout follows that of the `mlos_bench` module Full end-to-end examples are provided in the [`cli`](./cli/) directory, and typically and make use of the root [`CompositeEnvironments`](./environments/root/) to combine multiple [`Environments`](./environments/), also referencing [`Services`](./services/), [`Storage`](./storage/), and [`Optimizer`](./optimizers/) configs, into a single [`mlos_bench`](../run.py) run. +## See Also + +- [`mlos_bench.config`](https://microsoft.github.io/MLOS/autoapi/mlos_bench/config/index.html) module documentation online for detailed description and additional links to other components and their configuration examples. + ## Config parameters An `Environment` configuration can have two sections, `const_args` and `tunable_params`. @@ -44,6 +48,8 @@ The [`schemas`](./schemas/) directory contains the [`jsonschema`](https://json-s For instance including a `"$schema"` attribute at the top of your `json` config file will enable `json` validation and auto-complete in many editors (e.g. [VSCode](https://code.visualstudio.com/)): +Alternatively, you can simply name the file `*.mlos.json` or `*.mlos.jsonc` and the schema will be automatically applied using an [extension](https://marketplace.visualstudio.com/items?itemName=remcohaszing.schemastore) to resolve the rules from \