Populate T5X ReadTheDocs.

PiperOrigin-RevId: 538820972
google-research · Jun 8, 2023 · 7c0898c · 7c0898c
1 parent b1b6279
commit 7c0898c
Show file tree

Hide file tree

Showing 38 changed files with 357 additions and 25 deletions.
diff --git a/docs/_static/t5x_theme.css b/docs/_static/t5x_theme.css
@@ -0,0 +1,23 @@
+@import url("theme.css");
+
+.wy-nav-content {
+  max-width: 1290px;
+}
+
+.rst-content table.docutils {
+  width: 100%;
+}
+
+.rst-content table.docutils td {
+  vertical-align: top;
+  padding: 0;
+}
+
+.rst-content table.docutils td p {
+  padding: 8px;
+}
+
+.rst-content div[class^=highlight] {
+  border: 0;
+  margin: 0;
+}
diff --git a/docs/_templates/autosummary/t5x_module.rst b/docs/_templates/autosummary/t5x_module.rst
@@ -0,0 +1,23 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :exclude-members:
+
+   {% block methods %}
+
+   .. automethod:: __call__
+
+   {% if methods %}
+   .. rubric:: Methods
+
+   .. autosummary::
+
+   {% for item in methods %}
+   {%- if item not in inherited_members and item not in annotations and not item in ['__init__'] %}
+       ~{{ name }}.{{ item }}
+   {%- endif %}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
diff --git a/docs/api_reference/index.rst b/docs/api_reference/index.rst
@@ -0,0 +1,100 @@
+API Reference
+=============
+
+Binaries
+--------
+
+.. toctree::
+   :maxdepth: 3
+
+   t5x.train
+   t5x.infer
+   t5x.eval
+   t5x.main
+
+Training
+---------
+
+.. toctree::
+   :maxdepth: 3
+
+   t5x.trainer   
+   t5x.optimizers
+   t5x.interactive_model
+   t5x.train_state
+   t5x.state_utils
+   t5x.losses
+   t5x.metrics
+   t5x.utils
+   t5x.adafactor
+
+Inference
+---------
+
+.. toctree::
+   :maxdepth: 3
+
+   t5x.decoding
+
+Models
+------
+
+.. toctree::
+   :maxdepth: 3
+
+   t5x.models
+
+Checkpointing
+-------------
+
+.. toctree::
+   :maxdepth: 3
+
+   t5x.checkpoints
+   t5x.checkpoint_utils
+   t5x.checkpoint_importer
+
+
+Paritioning
+-----------
+
+.. toctree::
+   :maxdepth: 3
+
+   t5x.partitioning
+
+Config
+------
+
+.. toctree::
+   :maxdepth: 3
+
+   t5x.config_utils
+   t5x.gin_utils
+
+Utils
+-----
+
+.. toctree::
+   :maxdepth: 3
+
+   t5x.test_utils
+   t5x.binary_search
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/api_reference/t5x.adafactor.rst b/docs/api_reference/t5x.adafactor.rst
@@ -0,0 +1,7 @@
+t5x.adafactor package
+========================
+
+.. currentmodule:: t5x.adafactor
+
+.. automodule:: t5x.adafactor
+  :members:
diff --git a/docs/api_reference/t5x.binary_search.rst b/docs/api_reference/t5x.binary_search.rst
@@ -0,0 +1,7 @@
+t5x.binary_search package
+========================
+
+.. currentmodule:: t5x.binary_search
+
+.. automodule:: t5x.binary_search
+  :members:
diff --git a/docs/api_reference/t5x.checkpoint_importer.rst b/docs/api_reference/t5x.checkpoint_importer.rst
@@ -0,0 +1,7 @@
+t5x.checkpoint_importer package
+========================
+
+.. currentmodule:: t5x.checkpoint_importer
+
+.. automodule:: t5x.checkpoint_importer
+  :members:
diff --git a/docs/api_reference/t5x.checkpoint_utils.rst b/docs/api_reference/t5x.checkpoint_utils.rst
@@ -0,0 +1,7 @@
+t5x.checkpoint_utils package
+========================
+
+.. currentmodule:: t5x.checkpoint_utils
+
+.. automodule:: t5x.checkpoint_utils
+  :members:
diff --git a/docs/api_reference/t5x.checkpoints.rst b/docs/api_reference/t5x.checkpoints.rst
@@ -0,0 +1,7 @@
+t5x.checkpoints package
+========================
+
+.. currentmodule:: t5x.checkpoints
+
+.. automodule:: t5x.checkpoints
+  :members:
diff --git a/docs/api_reference/t5x.config_utils.rst b/docs/api_reference/t5x.config_utils.rst
@@ -0,0 +1,7 @@
+t5x.config_utils package
+========================
+
+.. currentmodule:: t5x.config_utils
+
+.. automodule:: t5x.config_utils
+  :members:
diff --git a/docs/api_reference/t5x.decoding.rst b/docs/api_reference/t5x.decoding.rst
@@ -0,0 +1,7 @@
+t5x.decoding package
+========================
+
+.. currentmodule:: t5x.decoding
+
+.. automodule:: t5x.decoding
+  :members:
diff --git a/docs/api_reference/t5x.eval.rst b/docs/api_reference/t5x.eval.rst
@@ -0,0 +1,7 @@
+t5x.eval binary
+========================
+
+.. currentmodule:: t5x.eval
+
+.. automodule:: t5x.eval
+  :members:
diff --git a/docs/api_reference/t5x.gin_utils.rst b/docs/api_reference/t5x.gin_utils.rst
@@ -0,0 +1,7 @@
+t5x.gin_utils package
+========================
+
+.. currentmodule:: t5x.gin_utils
+
+.. automodule:: t5x.gin_utils
+  :members:
diff --git a/docs/api_reference/t5x.infer.rst b/docs/api_reference/t5x.infer.rst
@@ -0,0 +1,7 @@
+t5x.infer binary
+========================
+
+.. currentmodule:: t5x.infer
+
+.. automodule:: t5x.infer
+  :members:
diff --git a/docs/api_reference/t5x.interactive_model.rst b/docs/api_reference/t5x.interactive_model.rst
@@ -0,0 +1,7 @@
+t5x.interactive_model package
+========================
+
+.. currentmodule:: t5x.interactive_model
+
+.. automodule:: t5x.interactive_model
+  :members:
diff --git a/docs/api_reference/t5x.losses.rst b/docs/api_reference/t5x.losses.rst
@@ -0,0 +1,7 @@
+t5x.losses package
+========================
+
+.. currentmodule:: t5x.losses
+
+.. automodule:: t5x.losses
+  :members:
diff --git a/docs/api_reference/t5x.main.rst b/docs/api_reference/t5x.main.rst
@@ -0,0 +1,7 @@
+t5x.main binary
+========================
+
+.. currentmodule:: t5x.main
+
+.. automodule:: t5x.main
+  :members:
diff --git a/docs/api_reference/t5x.metrics.rst b/docs/api_reference/t5x.metrics.rst
@@ -0,0 +1,7 @@
+t5x.metrics package
+========================
+
+.. currentmodule:: t5x.metrics
+
+.. automodule:: t5x.metrics
+  :members:
diff --git a/docs/api_reference/t5x.models.rst b/docs/api_reference/t5x.models.rst
@@ -0,0 +1,7 @@
+t5x.models package
+========================
+
+.. currentmodule:: t5x.models
+
+.. automodule:: t5x.models
+  :members:
diff --git a/docs/api_reference/t5x.optimizers.rst b/docs/api_reference/t5x.optimizers.rst
@@ -0,0 +1,7 @@
+t5x.optimizers package
+========================
+
+.. currentmodule:: t5x.optimizers
+
+.. automodule:: t5x.optimizers
+  :members:
diff --git a/docs/api_reference/t5x.partitioning.rst b/docs/api_reference/t5x.partitioning.rst
@@ -0,0 +1,7 @@
+t5x.partitioning package
+========================
+
+.. currentmodule:: t5x.partitioning
+
+.. automodule:: t5x.partitioning
+  :members:
diff --git a/docs/api_reference/t5x.state_utils.rst b/docs/api_reference/t5x.state_utils.rst
@@ -0,0 +1,7 @@
+t5x.state_utils package
+========================
+
+.. currentmodule:: t5x.state_utils
+
+.. automodule:: t5x.state_utils
+  :members:
diff --git a/docs/api_reference/t5x.test_utils.rst b/docs/api_reference/t5x.test_utils.rst
@@ -0,0 +1,7 @@
+t5x.test_utils package
+========================
+
+.. currentmodule:: t5x.test_utils
+
+.. automodule:: t5x.test_utils
+  :members:
diff --git a/docs/api_reference/t5x.train.rst b/docs/api_reference/t5x.train.rst
@@ -0,0 +1,7 @@
+t5x.train binary
+========================
+
+.. currentmodule:: t5x.train
+
+.. automodule:: t5x.train
+  :members:
diff --git a/docs/api_reference/t5x.train_state.rst b/docs/api_reference/t5x.train_state.rst
@@ -0,0 +1,7 @@
+t5x.train_state package
+========================
+
+.. currentmodule:: t5x.train_state
+
+.. automodule:: t5x.train_state
+  :members:
diff --git a/docs/api_reference/t5x.trainer.rst b/docs/api_reference/t5x.trainer.rst
@@ -0,0 +1,7 @@
+t5x.trainer package
+========================
+
+.. currentmodule:: t5x.trainer
+
+.. automodule:: t5x.trainer
+  :members:
diff --git a/docs/api_reference/t5x.utils.rst b/docs/api_reference/t5x.utils.rst
@@ -0,0 +1,7 @@
+t5x.utils package
+========================
+
+.. currentmodule:: t5x.utils
+
+.. automodule:: t5x.utils
+  :members:
diff --git a/t5x/docs/conf.py → docs/conf.py b/t5x/docs/conf.py → docs/conf.py
@@ -84,6 +84,11 @@
 html_theme = 'sphinx_book_theme'
 html_css_files = ['css/t5x_theme.css']
 
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+html_logo = './t5x.png'
+html_favicon = './t5x.png'
+
 # title of the website
 html_title = ''
 

diff --git a/t5x/docs/conf_sphinx_patch.py → docs/conf_sphinx_patch.py b/t5x/docs/conf_sphinx_patch.py → docs/conf_sphinx_patch.py
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,23 @@
+******************************
+T5X
+******************************
+
+
+T5X is a modular, composable, research-friendly framework for high-performance, 
+configurable, self-service training, evaluation, and inference of sequence
+models (starting with language) at many scales.
+
+It is essentially a new and improved implementation of the
+`T5 codebase <https://github.com/google-research/text-to-text-transfer-transformer/blob/main/README.md>`__
+(based on Mesh TensorFlow) in JAX and Flax. To learn more, see the
+`T5X Paper <https://arxiv.org/abs/2203.17189>`__.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Table of Contents
+
+   Quick Start <overview>
+   Tutorials <tutorials>
+   Usage Guides <usage/index>
+   Models <models>
+   api_reference/index
diff --git a/docs/overview.md b/docs/overview.md
@@ -0,0 +1,2 @@
+```{include} ../README.md
+```
diff --git a/t5x/docs/requirements.txt → docs/requirements.txt b/t5x/docs/requirements.txt → docs/requirements.txt
diff --git a/docs/t5x.png b/docs/t5x.png
diff --git a/docs/tutorials.md b/docs/tutorials.md
@@ -1,8 +1,6 @@
-[TOC]
-
 # T5X Introductory Tutorial Series
 
-## Welcome!
+## Overview
 
 This series of guides is a self-contained introduction to T5X, a modular,
 composable, research-friendly framework for high-performance, configurable,