Skip to content

Commit

Permalink
linting docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Tuan Tran committed Dec 10, 2023
1 parent 25fba98 commit b5a7b10
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions doc/reference/asset.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ fairseq2.asset
.. currentmodule:: fairseq2.asset

``fairseq2.asset`` provides API to load the different model using the "model cards" from different "stores".
``fairseq2.asset`` provides API to load the different model using the "model cards" from different "stores".

A model card is a .YAML file that contains information about a model and instructs a
:pc:class:`fairseq2.models.utils.generic_loaders.ModelLoader` on how to load the model into the memory.
A store is a place where all the model cards are stored. By default, fairseq2 will look up the following stores:
A model card is a .YAML file that contains information about a model and instructs a
:pc:class:`fairseq2.models.utils.generic_loaders.ModelLoader` on how to load the model into the memory.
A store is a place where all the model cards are stored. By default, fairseq2 will look up the following stores:

* System asset store: Cards that are shared by all users. By default, the system store is `/etc/fairseq2/assets`,
but this can be changed via the environment variable `FAIRSEQ2_ASSET_DIR`
* User asset store: Cards that are only available to the user. By default, the user store is
`~/.config/fairseq2/assets`, but this can be changed via the environment variable `FAIRSEQ2_USER_ASSET_DIR`
* (Internal only) Meta asset store: For Meta employees' convenience, we set up a central store that contains
model cards with e.g intermediate checkpoints, extra internal information etc. This store is registered automatically
when one logs into the Fair cluster. If you wish not to use this central store, set the environment variable
`NO_FAIR_CARD=ON`
* System asset store: Cards that are shared by all users. By default, the system store is `/etc/fairseq2/assets`,
but this can be changed via the environment variable `FAIRSEQ2_ASSET_DIR`
* User asset store: Cards that are only available to the user. By default, the user store is
`~/.config/fairseq2/assets`, but this can be changed via the environment variable `FAIRSEQ2_USER_ASSET_DIR`
* (Internal only) Meta asset store: For Meta employees' convenience, we set up a central store that contains
model cards with e.g intermediate checkpoints, extra internal information etc. This store is registered automatically
when one logs into the Fair cluster. If you wish not to use this central store, set the environment variable
`NO_FAIR_CARD=ON`

0 comments on commit b5a7b10

Please sign in to comment.