Skip to content

Commit

Permalink
Improve RTD docs.
Browse files Browse the repository at this point in the history
Ported from #648

PiperOrigin-RevId: 705158096
  • Loading branch information
trallard authored and copybara-github committed Dec 11, 2024
1 parent 1ed92a1 commit 6936055
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 23 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/preview_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ jobs:
steps:
- uses: readthedocs/actions/preview@v1
with:
project-slug: "readthedocs-preview"
project-slug: "google-grain"
single-version: true
55 changes: 33 additions & 22 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,36 +5,44 @@
Grain is a library for reading data for training and evaluating JAX models. It's
open source, fast and deterministic.

::::{grid} 1 2 2 3 :gutter: 1 1 1 2
::::{grid} 1 2 2 3
:gutter: 1 1 1 2

:::{grid-item-card} {octicon}`zap;1.5em;sd-mr-1` Powerful Users can bring
arbitrary Python transformations. :::
:::{grid-item-card} {octicon}`zap;1.5em;sd-mr-1` Powerful
Users can bring arbitrary Python transformations.
:::

:::{grid-item-card} {octicon}`tools;1.5em;sd-mr-1` Flexible Grain is designed to
:::{grid-item-card} {octicon}`tools;1.5em;sd-mr-1` Flexible
Grain is designed to
be modular. Users can readily override Grain components if need be with their
own implementation. :::
own implementation.
:::

:::{grid-item-card} {octicon}`versions;1.5em;sd-mr-1` Deterministic Multiple
runs of the same pipeline will produce the same output. :::
:::{grid-item-card} {octicon}`versions;1.5em;sd-mr-1` Deterministic
Multiple runs of the same pipeline will produce the same output.
:::

:::{grid-item-card} {octicon}`check-circle;1.5em;sd-mr-1` Resilient to
pre-emptions Grain is designed such that checkpoints have minimal size. After
:::{grid-item-card} {octicon}`check-circle;1.5em;sd-mr-1` Resilient to preemptions
Grain is designed such that checkpoints have minimal size. After
pre-emption, Grain can resume from where it left off and produce the same output
as if it was never pre-empted. :::
as if it was never preempted.
:::

:::{grid-item-card} {octicon}`sparkles-fill;1.5em;sd-mr-1` Performant We took
care while designing Grain to ensure that it's performant (refer to the
:::{grid-item-card} {octicon}`zap;1.5em;sd-mr-1` Performant
We took care while designing Grain to ensure that it's performant (refer to the
[Behind the Scenes](behind_the_scenes.md) section of the documentation.) We also
tested it against multiple data modalities (e.g.Text/Audio/Images/Videos). :::
tested it against multiple data modalities (e.g.Text/Audio/Images/Videos).
:::

:::{grid-item-card} {octicon}`package;1.5em;sd-mr-1` With minimal dependencies
Grain minimizes its set of dependencies when possible. For example, it should
not depend on TensorFlow. :::

not depend on TensorFlow.
:::
::::

``` {toctree}
:maxdepth: 1
:hidden:
:caption: Getting started
installation
behind_the_scenes
Expand All @@ -43,27 +51,30 @@ data_sources

``` {toctree}
:maxdepth: 1
:hidden:
:caption: Data Loader
data_loader/samplers
data_loader/transformations
```

``` {toctree}
:maxdepth: 1
:hidden:
:caption: Tutorials
tutorials/dataset_basic_tutorial
```

``` {toctree}
:maxdepth: 1
:caption: Contributor guides
CONTRIBUTING
```

<!-- Automatically generated documentation from docstrings -->

``` {toctree}
:maxdepth: 1
:hidden:
:caption: References
autoapi/index
```

``` {toctree}
:maxdepth: 1
:hidden:
:caption: Contributor guides
CONTRIBUTING
```

0 comments on commit 6936055

Please sign in to comment.