OpenDeltaMirror/docs/source/index.md

OpenDelta's documentation!

OpenDelta is a Plug-and-play Library of the parameter-efficient fine-tuning (delta-tuning) technology for pre-trained models.

Essential Advantages:

• Clean: No need to edit the backbone PTM’s codes.
• Simple: Migrating from full-model tuning to delta-tuning needs as little as 3 lines of codes.
• Sustainable: Most evolution in external library doesn’t require a new OpenDelta.
• Extendable: Various PTMs can share the same delta-tuning codes.
• Flexible: Able to apply delta-tuning to (almost) any position of the PTMs.

.. toctree::
   :maxdepth: 1
   :caption: Getting Started

   notes/overview.md
   notes/installation.md
   notes/quickstart.md
   notes/custom.md
   

.. toctree::
   :maxdepth: 1
   :caption: Advanced Usage
   
   notes/autodelta.md
   notes/deltacenter.md
   notes/composition.md
   notes/pluginunplug.md
   notes/withbmtrain.md
   notes/withaccelerate.md
   notes/examples.md

.. toctree::
   :maxdepth: 1
   :caption: Utilities
   
   notes/inspect.md

.. toctree::
   :maxdepth: 1
   :caption: Mechanisms

   notes/keyfeature.md
   notes/namebasedaddr.md
   notes/unifyname.md

.. toctree::
   :maxdepth: 1
   :caption: Information

   notes/citation.md
   notes/update.md
   notes/faq.md

.. toctree::
   :maxdepth: 2
   :caption: Documentation

   modules/base
   modules/deltas
   modules/auto_delta
   modules/utils


Indices and tables
==================

* :ref:`genindex`