.. Flax documentation main file, created by
   sphinx-quickstart on Mon Feb 17 11:41:38 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Flax documentation
==================

Flax is a neural network library and ecosystem for JAX that is
designed for flexibility. Flax is in use by a growing community of
researchers and engineers at Google who happily use Flax for their
daily research.

For a quick introduction and short example snippets, see our `README
<https://github.com/google/flax/blob/main/README.md>`_.

.. toctree::
   :maxdepth: 1
   :caption: Quickstart

   overview
   installation
   Examples <https://github.com/google/flax/tree/main/examples>

.. toctree::
   :maxdepth: 1
   :caption: Guided Tour

   notebooks/jax_for_the_impatient
   notebooks/flax_basics
   notebooks/annotated_mnist

.. toctree::
   :maxdepth: 1
   :caption: How do I ...?
   :glob:
   :titlesonly:

   howtos/state_params
   howtos/ensembling
   howtos/lr_schedule
   howtos/extracting_intermediates
   howtos/model_surgery
   howtos/convert_pytorch_to_flax
   howtos/optax_update_guide
   howtos/linen_upgrade_guide
   howtos/full_eval


.. toctree::
   :maxdepth: 1
   :caption: Design Notes
   :glob:
   :titlesonly:

   design_notes/*
   FLIPs <https://github.com/google/flax/tree/main/docs/flip>

.. toctree::
   :maxdepth: 1
   :caption: Additional material

   philosophy
   contributing

.. toctree::
   :maxdepth: 2
   :caption: API reference

   flax.linen
   flax.serialization
   flax.core.frozen_dict
   flax.struct
   flax.jax_utils
   flax.traceback_util
   flax.traverse_util
   flax.training
   flax.config
   flax.errors