OpenDeltaMirror/docs/source/index.md

56 lines
1.5 KiB
Markdown
Raw Normal View History

2022-02-14 21:19:03 +08:00
OpenDelta's documentation!
=====================================
OpenDelta is a **Plug-and-play** Library of the parameter-efficient fine-tuning ([delta-tuning](WhatisDelta)) technology for pre-trained models.
## Essential Advantages:
- <span style="color:rgb(81, 217, 245);font-weight:bold">Clean:</span> No need to edit the backbone PTMs codes.
- <span style="color:orange;font-weight:bold">Simple:</span> Migrating from full-model tuning to delta-tuning needs as little as 3 lines of codes.
- <span style="color:green;font-weight:bold">Sustainable:</span> Most evolution in external library doesnt require a new OpenDelta.
- <span style="color:red;font-weight:bold">Extendable:</span> Various PTMs can share the same delta-tuning codes.
- <span style="color:purple;font-weight:bold">Flexible:</span> Able to apply delta-tuning to (almost) any position of the PTMs.
```{eval-rst}
.. toctree::
:maxdepth: 1
:caption: Getting Started
notes/overview.md
notes/installation.md
notes/usage.md
2022-02-16 22:57:21 +08:00
notes/namebasedaddr.md
2022-02-14 21:19:03 +08:00
notes/visualization.md
notes/saveload.md
.. toctree::
:maxdepth: 1
:caption: Advanced Usage
notes/keyfeature.md
notes/unifyname.md
notes/autodelta.md
notes/composition.md
notes/pluginunplug.md
notes/acceleration.md
notes/explored_config.md
notes/citation.md
notes/faq.md
2022-02-14 21:19:03 +08:00
.. toctree::
:maxdepth: 2
:caption: Package Reference
modules/base
modules/deltas
modules/auto_delta
modules/utils
Indices and tables
==================
* :ref:`genindex`
```