Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 16 additions & 15 deletions docs/api_reference/faq_imports.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ Service Users
If you write client code interacting with the OSS Vizier service, use
these import targets:

- **``from vizier.service import pyvizier as vz``**: Exposes the same
set of symbol names as ``vizier.pyvizier``.
``vizier.service.pyvizier.Foo`` is a subclass or an alias of
``vizier.pyvizier.Foo``, and can be converted into protobufs.
- **``from vizier.service import ...``**: Include binaries and internal
- **from vizier.service import pyvizier as vz**: Exposes the same
set of symbol names as ``vizier.pyvizier``. ``vizier.service.pyvizier.Foo``
is a subclass or an alias of ``vizier.pyvizier.Foo``, and can be converted
into protobufs.
- **from vizier.service import ...**: Include binaries and internal
utilities.

Algorithm Developers
Expand All @@ -22,13 +22,13 @@ Algorithm Developers
If you write algorithm code (Designers or Pythia policies) in OSS
Vizier, use these import targets:

- **``from vizier import pyvizier as vz``**: Pure python building
- **from vizier import pyvizier as vz**: Pure python building
blocks of OSS Vizier. Cross-platform code, including Pythia policies,
must use this ``pyvizier`` instance.

- ``Trial`` and ``ProblemStatement`` are important classes.

- **``from vizier.pyvizier import converters``**: Convert between
- **from vizier.pyvizier import converters**: Convert between
``pyvizier`` objects and numpy arrays.

- ``TrialToNumpyDict``: Converts parameters (and metrics) into a
Expand All @@ -38,19 +38,20 @@ Vizier, use these import targets:
- ``TrialToArrayConverter``: Converts parameters (and metrics) into
an array.

- **``from vizier.interfaces import serializable``**
- **from vizier.interfaces import serializable**: Abstractions for
serializable objects.

- ``PartiallySerializable``, ``Serializable``

Algorithm Abstractions
~~~~~~~~~~~~~~~~~~~~~~

- **``from vizier import pythia``**
- **from vizier import pythia**: Abstractions for Pythia policies.

- ``Policy``, ``PolicySupporter``: Key abstractions.
- ``LocalPolicyRunner``: Use it for running a ``Policy`` in RAM.

- **``from vizier import algorithms``**
- **from vizier import algorithms**: Abstractions for algorithms.

- ``Designer``: Stateful algorithm abstraction.
- ``DesignerPolicy``: Wraps ``Designer`` into a Pythia Policy.
Expand All @@ -61,7 +62,7 @@ Algorithm Abstractions
Tensorflow Modules
~~~~~~~~~~~~~~~~~~

- **``from vizier import tfp``**: Tensorflow-Probability utilities.
- **from vizier import tfp**: Tensorflow-Probability utilities.

- ``acquisitions``: Acquisition functions module.

Expand All @@ -76,14 +77,14 @@ Tensorflow Modules
transformation.
- ``flip_sign``: returns a sign-flip bijector.

- **``from vizier import keras as vzk``**
- **from vizier import keras as vzk**:

- ``vzk.layers``: Layers usually wrapping ``tfp`` classes.

- ``variable_from_prior``: Utility layer for handling regularized
variables.

- ``vzk.optim``: Wrappers around optimizers in ``tfp``\ or
``keras``.
- ``vzk.models``: Most of the useful models don’t easily fit into
Keras’ ``Model`` abstraction, but we may add some for display.
Keras's ``Model`` abstraction, but we may add some for display.
- ``vzk.optim``: Wrappers around optimizers in ``tfp`` or
``keras``.
Loading