Doc additions

adapter-hub · Jun 20, 2022 · c325f45 · c325f45
1 parent 2af5e0d
commit c325f45
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/transformers/adapters/model_mixin.py b/src/transformers/adapters/model_mixin.py
@@ -785,6 +785,14 @@ def get_adapter(self, name) -> dict:
     def adapter_summary(self, as_dict=False) -> Union[str, dict]:
         """
         Returns a string summary of all adapters currently added to the model.
+        Each entry in the summary table has the following attributes:
+
+            - name: the name of the adapter
+            - architecture: the architectural base of the adapter
+            - #param: the number of parameters of the adapter
+            - %param: the number of parameters of the adapter relative to the full model
+            - active: whether the adapter is active
+            - train: whether the adapter weights are enabled for training
         """
         # table header
         header = ["name", "architecture", "#param", "%param", "active", "train"]