From c325f45fdab7cbba32e64436fd11985c129f56e8 Mon Sep 17 00:00:00 2001 From: calpt <36051308+calpt@users.noreply.github.com> Date: Mon, 20 Jun 2022 18:41:19 +0200 Subject: [PATCH] Doc additions --- src/transformers/adapters/model_mixin.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/transformers/adapters/model_mixin.py b/src/transformers/adapters/model_mixin.py index 1cf7b4f7cd..734dd0f929 100644 --- 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"]