Skip to content

Commit

Permalink
Small aesthetic doc fixes
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 701682491
  • Loading branch information
xingyousong authored and copybara-github committed Dec 1, 2024
1 parent 6348a8c commit d78ffb2
Showing 1 changed file with 16 additions and 17 deletions.
33 changes: 16 additions & 17 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,13 +62,11 @@ Algorithm Abstractions
Tensorflow Modules
~~~~~~~~~~~~~~~~~~

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

- ``acquisitions``: Acquisition functions module.

- ``AcquisitionFunction``: Abstraction.
- ``UpperConfidenceBound``, ``ExpectedImprovement``, etc.

- ``bijectors``: Bijectors module.

- ``YeoJohnson``: Implements both Yeo-Johnson and Box-Cox
Expand All @@ -76,14 +75,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``.

0 comments on commit d78ffb2

Please sign in to comment.