Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
chenpangpang
transformers
Commits
ca3fc36d
Unverified
Commit
ca3fc36d
authored
Sep 28, 2020
by
Sylvain Gugger
Committed by
GitHub
Sep 28, 2020
Browse files
Reorganize documentation navbar (#7423)
* Reorganize documentation navbar * Update css to have clear sections
parent
7f4115c0
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
51 additions
and
32 deletions
+51
-32
docs/source/_static/css/huggingface.css
docs/source/_static/css/huggingface.css
+6
-0
docs/source/index.rst
docs/source/index.rst
+45
-32
No files found.
docs/source/_static/css/huggingface.css
View file @
ca3fc36d
...
@@ -125,6 +125,12 @@ a.copybtn {
...
@@ -125,6 +125,12 @@ a.copybtn {
background-color
:
#6670FF
;
background-color
:
#6670FF
;
}
}
/* The section headers in the toc tree */
.wy-menu-vertical
p
.caption
{
background-color
:
#4d59ff
;
line-height
:
40px
;
}
/* The selected items in the toc tree */
/* The selected items in the toc tree */
.wy-menu-vertical
li
.current
{
.wy-menu-vertical
li
.current
{
background-color
:
#A6B0FF
;
background-color
:
#A6B0FF
;
...
...
docs/source/index.rst
View file @
ca3fc36d
...
@@ -46,7 +46,10 @@ The documentation is organized in five parts:
...
@@ -46,7 +46,10 @@ The documentation is organized in five parts:
- **ADVANCED GUIDES** contains more advanced guides that are more specific to a given script or part of the library.
- **ADVANCED GUIDES** contains more advanced guides that are more specific to a given script or part of the library.
- **RESEARCH** focuses on tutorials that have less to do with how to use the library but more about general resarch in
- **RESEARCH** focuses on tutorials that have less to do with how to use the library but more about general resarch in
transformers model
transformers model
- **PACKAGE REFERENCE** contains the documentation of each public class and function.
- The three last section contain the documentation of each public class and function, grouped in:
- **MAIN CLASSES** for the main classes exposing the important APIs of the library.
- **MODELS** for the classes and functions related to each model implemented in the library.
- **INTERNAL HELPERS** for the classes and functions we use internally.
The library currently contains PyTorch and Tensorflow implementations, pre-trained model weights, usage scripts and
The library currently contains PyTorch and Tensorflow implementations, pre-trained model weights, usage scripts and
conversion utilities for the following models:
conversion utilities for the following models:
...
@@ -188,50 +191,60 @@ conversion utilities for the following models:
...
@@ -188,50 +191,60 @@ conversion utilities for the following models:
.. toctree::
.. toctree::
:maxdepth: 2
:maxdepth: 2
:caption:
Package Reference
:caption:
Main Classes
main_classes/configuration
main_classes/configuration
main_classes/
output
main_classes/
logging
main_classes/model
main_classes/model
main_classes/tokenizer
main_classes/pipelines
main_classes/trainer
main_classes/optimizer_schedules
main_classes/optimizer_schedules
main_classes/output
main_classes/pipelines
main_classes/processors
main_classes/processors
main_classes/logging
main_classes/tokenizer
main_classes/trainer
.. toctree::
:maxdepth: 2
:caption: Models
model_doc/albert
model_doc/auto
model_doc/auto
model_doc/
encoderdecoder
model_doc/
bart
model_doc/bert
model_doc/bert
model_doc/gpt
model_doc/bertgeneration
model_doc/transformerxl
model_doc/gpt2
model_doc/xlm
model_doc/xlnet
model_doc/roberta
model_doc/distilbert
model_doc/ctrl
model_doc/camembert
model_doc/camembert
model_doc/albert
model_doc/ctrl
model_doc/xlmroberta
model_doc/flaubert
model_doc/bart
model_doc/t5
model_doc/electra
model_doc/dialogpt
model_doc/dialogpt
model_doc/reformer
model_doc/distilbert
model_doc/marian
model_doc/longformer
model_doc/retribert
model_doc/mobilebert
model_doc/dpr
model_doc/dpr
model_doc/pegasus
model_doc/electra
model_doc/mbart
model_doc/encoderdecoder
model_doc/flaubert
model_doc/fsmt
model_doc/fsmt
model_doc/funnel
model_doc/funnel
model_doc/lxmert
model_doc/bertgeneration
model_doc/layoutlm
model_doc/layoutlm
model_doc/longformer
model_doc/lxmert
model_doc/marian
model_doc/mbart
model_doc/mobilebert
model_doc/gpt
model_doc/gpt2
model_doc/pegasus
model_doc/rag
model_doc/rag
model_doc/reformer
model_doc/retribert
model_doc/roberta
model_doc/t5
model_doc/transformerxl
model_doc/xlm
model_doc/xlmroberta
model_doc/xlnet
.. toctree::
:maxdepth: 2
:caption: Internal Helpers
internal/modeling_utils
internal/modeling_utils
internal/tokenization_utils
internal/pipelines_utils
internal/pipelines_utils
internal/tokenization_utils
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment