Skip to content

Commit

Permalink
README updates
Browse files Browse the repository at this point in the history
Backreference links to/from pypi.org
  • Loading branch information
bpkroth committed Jan 9, 2024
1 parent c7df7ff commit 23ac4f4
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,10 @@ See Also:
## Installation
The MLOS modules are published to [pypi](https://pypi.org) when new tags/releases are made.
The MLOS modules are published to [pypi](https://pypi.org) when new releases are tagged:
- [mlos-core](https://pypi.org/project/mlos-core/)
- [mlos-bench](https://pypi.org/project/mlos-bench/)
To install the latest release, simply run:
Expand Down
2 changes: 2 additions & 0 deletions mlos_bench/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ This [directory](./) contains the code for the `mlos-bench` experiment runner pa

It makes use of the [`mlos-core`](../mlos_core/) package for its optimizer.

It's available for `pip install` via the pypi repository at [mlos-bench](https://pypi.org/project/mlos-bench/).

## Table of Contents

<!-- markdownlint-disable MD007 -->
Expand Down
2 changes: 2 additions & 0 deletions mlos_core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This [directory](./) contains the code for the `mlos-core` optimizer package.

It's available for `pip install` via the pypi repository at [mlos-core](https://pypi.org/project/mlos-core/).

## Description

`mlos-core` is an optimizer package, wrapping other libraries like FLAML and SMAC to use techniques like Bayesian optimization and others to identify & sample tunable configuration parameters and propose optimal parameter values with a consistent API: `suggest` and `register`.
Expand Down

0 comments on commit 23ac4f4

Please sign in to comment.