add licensing notices

Signed-off-by: Yu Chin Fabian Lim <[email protected]>

plugins/framework/README.md

@@ -88,3 +88,50 @@ Each [package](#packages) in this monorepo:
 
 - When instantiating `fms_acceleration.AccelerationFramework`, it internally parses through the configuration stanzas. For plugins that are installed, it will instantiate them; for those that are not, it will simply *passthrough*.
 - `AccelerationFramework` will manage plugins transparently for user. User only needs to call `AccelerationFramework.model_loader` and `AccelerationFramework.augmentation`.
+
+## Adding New Plugins
+
+To add new plugins:
+
+1. Create an appropriately `pip`-packaged plugin in `plugins`; the package needs to be named like `fms-acceleration-<postfix>` .
+2. For `framework` to properly load and manage plugin, add the package `<postfix>` to [constants.py](./src/fms_acceleration/constants.py):
+
+    ```python
+    PLUGINS = [
+        "peft",
+        "unsloth",
+        "<postfix>",
+    ]
+    ```
+3. Create a sample template YAML file inside the `<PLUGIN_DIR>/configs` to demonstrate how to configure the plugin. As an example, reference the [sample config for accelerated peft](../accelerated-peft/configs/autogptq.yaml).
+4. Update [generate_sample_configurations.py](../../scripts/generate_sample_configurations.py) and run `tox -e gen-configs` on the top level directory to generate the sample configurations.
+
+    ```python
+    KEY_AUTO_GPTQ = "auto_gptq"
+    KEY_BNB_NF4 = "bnb-nf4"
+    PLUGIN_A = "<NEW PLUGIN NAME>"
+
+    CONFIGURATIONS = {
+        KEY_AUTO_GPTQ: "plugins/accelerated-peft/configs/autogptq.yaml",
+        KEY_BNB_NF4: (
+            "plugins/accelerated-peft/configs/bnb.yaml",
+            [("peft.quantization.bitsandbytes.quant_type", "nf4")],
+        ),
+        PLUGIN_A: (
+            "plugins/<plugin>/configs/plugin_config.yaml",
+            [
+                (<1st field in plugin_config.yaml>, <value>),
+                (<2nd field in plugin_config.yaml>, <value>),
+            ]
+        )
+    }
+
+    # Passing a tuple of configuration keys will combine the templates together
+    COMBINATIONS = [
+        ("accelerated-peft-autogptq", (KEY_AUTO_GPTQ,)),
+        ("accelerated-peft-bnb-nf4", (KEY_BNB_NF4,)),    
+        (<"combined name with your plugin">), (KEY_AUTO_GPTQ, PLUGIN_A)
+        (<"combined name with your plugin">), (KEY_BNB_NF4, PLUGIN_A)
+    ]
+    ```
+5. Update [scenarios YAML](../../scripts/benchmarks/scenarios.yaml) to configure benchmark test scenarios that will be triggered when running `tox -e run-benches` on the top level directory.

plugins/fused-ops-and-kernels/src/fms_acceleration_foak/__init__.py

@@ -1 +1,15 @@
+# Copyright The FMS HF Tuning Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 from .framework_plugin_fast_quantized_peft import FastQuantizedPeftAccelerationPlugin

plugins/fused-ops-and-kernels/src/fms_acceleration_foak/framework_plugin_fast_quantized_peft.py

@@ -1,3 +1,17 @@
+# Copyright The FMS HF Tuning Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 from transformers import TrainingArguments
 from peft import LoraConfig
 from typing import Tuple, Dict, Callable

plugins/fused-ops-and-kernels/src/fms_acceleration_foak/fused_ops/__init__.py

@@ -0,0 +1,13 @@
+# Copyright 2023-present Daniel Han-Chen & the Unsloth team. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

plugins/fused-ops-and-kernels/src/fms_acceleration_foak/fused_ops/unsloth_lora/gptq/__init__.py

@@ -0,0 +1,3 @@
+# taken from 
+# https://github.com/jeromeku/unsloth/commit/
+# 2839d390ef3bb318904289bfb9a7751a782c4e44

plugins/fused-ops-and-kernels/src/fms_acceleration_foak/fused_ops/unsloth_lora/gptq/fast_lora.py

@@ -1,3 +1,7 @@
+# taken from 
+# https://github.com/jeromeku/unsloth/commit/
+# 2839d390ef3bb318904289bfb9a7751a782c4e44
+
 import math
 from dataclasses import dataclass
 from logging import getLogger

plugins/fused-ops-and-kernels/src/fms_acceleration_foak/fused_ops/unsloth_lora/gptq/triton/__init__.py

@@ -0,0 +1,3 @@
+# taken from 
+# https://github.com/jeromeku/unsloth/commit/
+# 2839d390ef3bb318904289bfb9a7751a782c4e44

plugins/fused-ops-and-kernels/src/fms_acceleration_foak/fused_ops/unsloth_lora/gptq/triton/kernels.py

@@ -1,3 +1,7 @@
+# taken from 
+# https://github.com/jeromeku/unsloth/commit/
+# 2839d390ef3bb318904289bfb9a7751a782c4e44
+
 import itertools
 from logging import getLogger
 

plugins/fused-ops-and-kernels/src/fms_acceleration_foak/fused_ops/unsloth_lora/gptq/triton/layers.py

@@ -1,3 +1,7 @@
+# taken from 
+# https://github.com/jeromeku/unsloth/commit/
+# 2839d390ef3bb318904289bfb9a7751a782c4e44
+
 import logging
 
 import torch

plugins/fused-ops-and-kernels/src/fms_acceleration_foak/fused_ops/unsloth_lora/gptq/triton/tuner.py

@@ -1,3 +1,7 @@
+# taken from 
+# https://github.com/jeromeku/unsloth/commit/
+# 2839d390ef3bb318904289bfb9a7751a782c4e44
+
 import builtins
 import heapq
 import math

plugins/fused-ops-and-kernels/src/fms_acceleration_foak/kernels/__init__.py

@@ -0,0 +1,13 @@
+# Copyright 2023-present Daniel Han-Chen & the Unsloth team. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

plugins/fused-ops-and-kernels/src/fms_acceleration_foak/models/__init__.py

@@ -1,3 +1,17 @@
+# Copyright The FMS HF Tuning Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 from .model_patcher import ModelPatcher
 
 PATCHES = [

plugins/fused-ops-and-kernels/src/fms_acceleration_foak/models/llama.py

@@ -1,3 +1,17 @@
+# Copyright The FMS HF Tuning Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 from transformers.models.llama.modeling_llama import LlamaAttention
 from transformers.models.llama.modeling_llama import LlamaRMSNorm
 

plugins/fused-ops-and-kernels/src/fms_acceleration_foak/models/mistral.py

@@ -1,3 +1,17 @@
+# Copyright The FMS HF Tuning Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 from transformers.models.mistral.modeling_mistral import MistralAttention
 from transformers.models.mistral.modeling_mistral import MistralRMSNorm
 

plugins/fused-ops-and-kernels/src/fms_acceleration_foak/models/model_patcher.py

@@ -1,3 +1,17 @@
+# Copyright The FMS HF Tuning Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 from dataclasses import dataclass, asdict
 from typing import Type, Callable, Union, List, Dict, Tuple, Set, Optional, Any
 import torch

plugins/fused-ops-and-kernels/src/fms_acceleration_foak/models/utils.py

@@ -1,3 +1,17 @@
+# Copyright The FMS HF Tuning Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 import torch
 from typing import Callable, List, Type