This release is a pre-release and may not be stable for production use.
Open Source Vizier: Reliable and Flexible Black-Box Optimization.
Google AI Blog | Getting Started | Documentation | Installation | Citing and Highlights
What is Open Source (OSS) Vizier?
OSS Vizier is a Python-based service for black-box optimization and research, based on Google Vizier, one of the first hyperparameter tuning services designed to work at scale.
OSS Vizier's distributed client-server system. Animation by Tom Small.
Getting Started
As a basic example for users, below shows how to tune a simple objective using all flat search space types:
from vizier.service import clients
from vizier.service import pyvizier as vz
# Objective function to maximize.
def evaluate(w: float, x: int, y: float, z: str) -> float:
return w**2 - y**2 + x * ord(z)
# Algorithm, search space, and metrics.
study_config = vz.StudyConfig(algorithm='DEFAULT')
study_config.search_space.root.add_float_param('w', 0.0, 5.0)
study_config.search_space.root.add_int_param('x', -2, 2)
study_config.search_space.root.add_discrete_param('y', [0.3, 7.2])
study_config.search_space.root.add_categorical_param('z', ['a', 'g', 'k'])
study_config.metric_information.append(vz.MetricInformation('metric_name', goal=vz.ObjectiveMetricGoal.MAXIMIZE))
# Setup client and begin optimization. Vizier Service will be implicitly created.
study = clients.Study.from_study_config(study_config, owner='my_name', study_id='example')
for i in range(10):
suggestions = study.suggest(count=2)
for suggestion in suggestions:
params = suggestion.parameters
objective = evaluate(params['w'], params['x'], params['y'], params['z'])
suggestion.complete(vz.Measurement({'metric_name': objective}))
Documentation
OSS Vizier's interface consists of three main APIs:
- User API: Allows a user to optimize their blackbox objective and optionally setup a server for distributed multi-client settings.
- Developer API: Defines abstractions and utilities for implementing new optimization algorithms for research and to be hosted in the service.
- Benchmarking API: A wide collection of objective functions and methods to benchmark and compare algorithms.
Additionally, it contains advanced API for:
- Tensorflow Probability: For writing Bayesian Optimization algorithms using Tensorflow Probability and Flax.
- PyGlove: For large-scale evolutionary experimentation and program search using OSS Vizier as a distributed backend.
Please see OSS Vizier's ReadTheDocs documentation for detailed information.
Installation
Quick start: For tuning objectives using our state-of-the-art JAX-based Bayesian Optimizer, run:
pip install google-vizier[jax]
Advanced Installation
Minimal version: To install only the core service and client APIs from requirements.txt, run:
pip install google-vizier
Full installation: To support all algorithms and benchmarks, run:
pip install google-vizier[all]
Specific installation: If you only need a specific part "X" of OSS Vizier, run:
pip install google-vizier[X]
which installs add-ons from requirements-X.txt. Possible options:
requirements-jax.txt: Jax libraries shared by both algorithms and benchmarks.requirements-tf.txt: Tensorflow libraries used by benchmarks.requirements-algorithms.txt: Additional repositories (e.g. EvoJAX) for algorithms.requirements-benchmarks.txt: Additional repositories (e.g. NASBENCH-201) for benchmarks.requirements-test.txt: Libraries needed for testing code.
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+.
Citing and Highlights
Citing Vizier: Please consider citing the appropriate paper(s): Algorithm, OSS Package, and Google System if you found any of them useful.
Highlights: We track notable users and media attention - let us know if OSS Vizier was helpful for your work.
Thanks!
@article{gaussian_process_bandit,
author = {Xingyou Song and
Qiuyi Zhang and
Chansoo Lee and
Emily Fertig and
Tzu-Kuo Huang and
Lior Belenki and
Greg Kochanski and
Setareh Ariafar and
Srinivas Vasudevan and
Sagi Perel and
Daniel Golovin},
title = {The Vizier Gaussian Process Bandit Algorithm},
journal = {Google DeepMind Technical Report},
year = {2024},
eprinttype = {arXiv},
eprint = {2408.11527},
}
@inproceedings{oss_vizier,
author = {Xingyou Song and
Sagi Perel and
Chansoo Lee and
Greg Kochanski and
Daniel Golovin},
title = {Open Source Vizier: Distributed Infrastructure and API for Reliable and Flexible Black-box Optimization},
booktitle = {Automated Machine Learning Conference, Systems Track (AutoML-Conf Systems)},
year = {2022},
}
@inproceedings{google_vizier,
author = {Daniel Golovin and
Benjamin Solnik and
Subhodeep Moitra and
Greg Kochanski and
John Karro and
D. Sculley},
title = {Google Vizier: {A} Service for Black-Box Optimization},
booktitle = {Proceedings of the 23rd {ACM} {SIGKDD} International Conference on
Knowledge Discovery and Data Mining, Halifax, NS, Canada, August 13
- 17, 2017},
pages = {1487--1495},
publisher = {{ACM}},
year = {2017},
url = {https://doi.org/10.1145/3097983.3098043},
doi = {10.1145/3097983.3098043},
}
1 maintainer
Metadata
1 maintainer
Release files for google-vizier-dev 0.1.18.dev20240923184110
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| google-vizier-dev-0.1.18.dev20240923184110.tar.gz | 509.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| google_vizier_dev-0.1.18.dev20240923184110-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.3 MB
Release files / google-vizier-dev-0.1.18.dev20240923184110.tar.gz
| Download URL | google-vizier-dev-0.1.18.dev20240923184110.tar.gz |
|---|---|
| Size | 509.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
97beb80d1d94dec33ebe394bcb27fb098e0c5e0a5a520ae2836fec5b6d142cc7
|
|
BLAKE2b-256 checksum How to use checksums |
7b4248115752d4354ec88fe43fae8764d27651f88b0ca42ea87952c800ca049e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.10.15
|
Release files / google_vizier_dev-0.1.18.dev20240923184110-py3-none-any.whl
| Download URL | google_vizier_dev-0.1.18.dev20240923184110-py3-none-any.whl |
|---|---|
| Size | 790.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f888d601ddae331355851ac1cf4f1d4bb84000e2f86e857a0187c6db416b9a48
|
|
BLAKE2b-256 checksum How to use checksums |
40329cb370e0d95511923a6db6f0aa4e7716ec5c2c36fef0a2dd1feb768db7cd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.10.15
|
