Skip to content

Commit 72b45e3

Browse files
xingyousongcopybara-github
authored andcommitted
Add dev version in README and slightly improve supported algorithms writing
PiperOrigin-RevId: 695079955
1 parent 5cb2392 commit 72b45e3

File tree

2 files changed

+18
-12
lines changed

2 files changed

+18
-12
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ pip install google-vizier[jax]
7575
```
7676

7777
### Advanced Installation
78-
**Minimal version:** To install only the core service and client APIs from `requirements.txt`, run:
78+
**Minimal installation:** To install only the core service and client APIs from `requirements.txt`, run:
7979

8080
```bash
8181
pip install google-vizier
@@ -101,6 +101,12 @@ which installs add-ons from `requirements-X.txt`. Possible options:
101101
* `requirements-benchmarks.txt`: Additional repositories (e.g. NASBENCH-201) for benchmarks.
102102
* `requirements-test.txt`: Libraries needed for testing code.
103103

104+
**Developer installation:** To install up to the latest commit, run:
105+
106+
```bash
107+
pip install google-vizier-dev[X]
108+
```
109+
104110
Check if all unit tests work by running `run_tests.sh` after a full installation. OSS Vizier requires Python 3.10+, while client-only packages require Python 3.8+.
105111

106112
## Citing and Highlights <a name="citing_vizier"></a>

docs/guides/user/supported_algorithms.ipynb

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
"While we service all algorithms to the user in our [policy factory](https://github.com/google/vizier/blob/main/vizier/_src/service/policy_factory.py), many can be organized by what level of support we provide to them, in terms of:\n",
1111
"\n",
1212
"* Search space (**Flat**, **Continuous-Only**, **Boolean-Only**)\n",
13-
"* Sequential or batched (**Batch**)\n",
14-
"* Single or multi-objective (**Multi-Objective**)"
13+
"* Allowing batched suggestions (**+Batch**)\n",
14+
"* Allowing multiple objectives (**+MO**)"
1515
]
1616
},
1717
{
@@ -23,13 +23,13 @@
2323
"## Official\n",
2424
"The following algorithms can be considered \"official\" and production-quality:\n",
2525
"\n",
26-
"1. [**GP-UCB-PE**](https://github.com/google/vizier/blob/main/vizier/_src/algorithms/designers/gp_ucb_pe.py) (`GP_UCB_PE`) \\[**Flat**, **Batch**\\]\n",
27-
"2. [**GP-Bandit**](https://github.com/google/vizier/blob/main/vizier/_src/algorithms/designers/gp_bandit.py) (`GAUSSIAN_PROCESS_BANDIT`) \\[**Flat**, **Multi-Objective**\\]\n",
28-
"3. [**Random Search**](https://github.com/google/vizier/blob/main/vizier/_src/algorithms/designers/random.py) (`RANDOM_SEARCH`) \\[**Flat**, **Batch**, **Multi-Objective**\\]\n",
29-
"4. [**Quasi-Random Search**](https://github.com/google/vizier/blob/main/vizier/_src/algorithms/designers/quasi_random.py) (`QUASI_RANDOM_SEARCH`) \\[**Flat**, **Batch**, **Multi-Objective**\\]\n",
30-
"5. [**Grid Search**](https://github.com/google/vizier/blob/main/vizier/_src/algorithms/designers/grid.py) (`GRID_SEARCH`) \\[**Flat**, **Batch**, **Multi-Objective**\\]\n",
31-
"6. [**Shuffled Grid Search**](https://github.com/google/vizier/blob/main/vizier/_src/algorithms/designers/grid.py) (`SHUFFLED_GRID_SEARCH`) \\[**Flat**, **Batch**, **Multi-Objective**\\]\n",
32-
"7. [**Eagle Strategy**](https://github.com/google/vizier/blob/main/vizier/_src/algorithms/designers/eagle_strategy/eagle_strategy.py) (`EAGLE_STRATEGY`) \\[**Flat**, **Batch**\\]"
26+
"1. [**GP-UCB-PE**](https://github.com/google/vizier/blob/main/vizier/_src/algorithms/designers/gp_ucb_pe.py) (`GP_UCB_PE`) \\[**Flat**, **+Batch**\\]\n",
27+
"2. [**GP-Bandit**](https://github.com/google/vizier/blob/main/vizier/_src/algorithms/designers/gp_bandit.py) (`GAUSSIAN_PROCESS_BANDIT`) \\[**Flat**, **+MO**\\]\n",
28+
"3. [**Random Search**](https://github.com/google/vizier/blob/main/vizier/_src/algorithms/designers/random.py) (`RANDOM_SEARCH`) \\[**Flat**, **+Batch**, **+MO**\\]\n",
29+
"4. [**Quasi-Random Search**](https://github.com/google/vizier/blob/main/vizier/_src/algorithms/designers/quasi_random.py) (`QUASI_RANDOM_SEARCH`) \\[**Flat**, **+Batch**, **+MO**\\]\n",
30+
"5. [**Grid Search**](https://github.com/google/vizier/blob/main/vizier/_src/algorithms/designers/grid.py) (`GRID_SEARCH`) \\[**Flat**, **+Batch**, **+MO**\\]\n",
31+
"6. [**Shuffled Grid Search**](https://github.com/google/vizier/blob/main/vizier/_src/algorithms/designers/grid.py) (`SHUFFLED_GRID_SEARCH`) \\[**Flat**, **+Batch**, **+MO**\\]\n",
32+
"7. [**Eagle Strategy**](https://github.com/google/vizier/blob/main/vizier/_src/algorithms/designers/eagle_strategy/eagle_strategy.py) (`EAGLE_STRATEGY`) \\[**Flat**, **+Batch**\\]"
3333
]
3434
},
3535
{
@@ -41,7 +41,7 @@
4141
"## External + Imported\n",
4242
"These algorithms are imported and wrapped from external packages (requiring additional installations via `pip install google-vizier[algorithms]`), and thus we cannot fully control their performance:\n",
4343
"\n",
44-
"1. [**CMA-ES**](https://github.com/google/vizier/blob/main/vizier/_src/algorithms/designers/cmaes.py) (`CMA_ES`): \\[**Continuous**, **Batch**\\]"
44+
"1. [**CMA-ES**](https://github.com/google/vizier/blob/main/vizier/_src/algorithms/designers/cmaes.py) (`CMA_ES`): \\[**Continuous-Only**, **+Batch**\\]"
4545
]
4646
},
4747
{
@@ -53,7 +53,7 @@
5353
"## Reproduced\n",
5454
"These algorithms are attempted reproductions of their original papers, sometimes using the authors' original implementations as inspiration (but not as direct imports). While we try our best to ensure their quality, we cannot guarantee exact performance:\n",
5555
"\n",
56-
"1. [**NSGA-II**](https://github.com/google/vizier/blob/main/vizier/_src/algorithms/evolution/nsga2.py) (`NSGA2`) \\[**Flat**, **Batch**, **Multi-Objective**\\]\n",
56+
"1. [**NSGA-II**](https://github.com/google/vizier/blob/main/vizier/_src/algorithms/evolution/nsga2.py) (`NSGA2`) \\[**Flat**, **+Batch**, **+MO**\\]\n",
5757
"2. [**Bayesian Optimization of Combinatorial Structures**](https://github.com/google/vizier/blob/main/vizier/_src/algorithms/designers/bocs.py) (`BOCS`) \\[**Boolean Only**\\]\n",
5858
"3. [**Harmonica**](https://github.com/google/vizier/blob/main/vizier/_src/algorithms/designers/harmonica.py) (`HARMONICA`) \\[**Boolean Only**\\]"
5959
]

0 commit comments

Comments
 (0)