Granite language models

docs/source/en/_toctree.yml

@@ -400,6 +400,8 @@
         title: GPTSAN Japanese
       - local: model_doc/gpt-sw3
         title: GPTSw3
+      - local: model_doc/granite
+        title: Granite
       - local: model_doc/herbert
         title: HerBERT
       - local: model_doc/ibert

docs/source/en/model_doc/granite.md

@@ -0,0 +1,63 @@
+<!--Copyright 2024 The HuggingFace 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.
+
+⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+
+-->
+
+# Granite
+
+## Overview
+
+The Granite model was proposed in [<INSERT PAPER NAME HERE>](<INSERT PAPER LINK HERE>) by <INSERT AUTHORS HERE>.
+<INSERT SHORT SUMMARY HERE>
+
+The abstract from the paper is the following:
+
+*<INSERT PAPER ABSTRACT HERE>*
+
+Tips:
+
+<INSERT TIPS ABOUT MODEL HERE>
+
+This model was contributed by [INSERT YOUR HF USERNAME HERE](https://huggingface.co/<INSERT YOUR HF USERNAME HERE>).
+The original code can be found [here](<INSERT LINK TO GITHUB REPO HERE>).
+
+
+## GraniteConfig
+
+[[autodoc]] GraniteConfig
+
+## GraniteModel
+
+[[autodoc]] GraniteModel
+    - forward
+
+## GraniteForCausalLM
+
+[[autodoc]] GraniteForCausalLM
+    - forward
+
+## GraniteForSequenceClassification
+
+[[autodoc]] GraniteForSequenceClassification
+    - forward
+
+## GraniteForQuestionAnswering
+
+[[autodoc]] GraniteForQuestionAnswering
+    - forward
+
+## GraniteForTokenClassification
+
+[[autodoc]] GraniteForTokenClassification
+    - forward

src/transformers/__init__.py

@@ -502,6 +502,7 @@
     "models.levit": ["LevitConfig"],
     "models.lilt": ["LiltConfig"],
     "models.llama": ["LlamaConfig"],
+    "models.granite": ["GraniteConfig"],
     "models.llava": [
         "LlavaConfig",
         "LlavaProcessor",
@@ -2403,6 +2404,16 @@
             "LlamaPreTrainedModel",
         ]
     )
+    _import_structure["models.granite"].extend(
+        [
+            "GraniteForCausalLM",
+            "GraniteForQuestionAnswering",
+            "GraniteForSequenceClassification",
+            "GraniteForTokenClassification",
+            "GraniteModel",
+            "GranitePreTrainedModel",
+        ]
+    )
     _import_structure["models.llava"].extend(
         [
             "LlavaForConditionalGeneration",
@@ -5097,6 +5108,7 @@
     from .models.levit import LevitConfig
     from .models.lilt import LiltConfig
     from .models.llama import LlamaConfig
+    from .models.granite import GraniteConfig
     from .models.llava import (
         LlavaConfig,
         LlavaProcessor,
@@ -6822,6 +6834,14 @@
             LlamaModel,
             LlamaPreTrainedModel,
         )
+        from .models.granite import (
+            GraniteForCausalLM,
+            GraniteForQuestionAnswering,
+            GraniteForSequenceClassification,
+            GraniteForTokenClassification,
+            GraniteModel,
+            GranitePreTrainedModel,
+        )
         from .models.llava import (
             LlavaForConditionalGeneration,
             LlavaPreTrainedModel,

src/transformers/models/__init__.py

@@ -122,6 +122,7 @@
     levit,
     lilt,
     llama,
+    granite,
     llava,
     llava_next,
     longformer,

src/transformers/models/auto/configuration_auto.py

@@ -139,6 +139,7 @@
         ("levit", "LevitConfig"),
         ("lilt", "LiltConfig"),
         ("llama", "LlamaConfig"),
+        ("granite", "GraniteConfig"),
         ("llava", "LlavaConfig"),
         ("llava_next", "LlavaNextConfig"),
         ("longformer", "LongformerConfig"),
@@ -414,6 +415,7 @@
         ("levit", "LeViT"),
         ("lilt", "LiLT"),
         ("llama", "LLaMA"),
+        ("granite", "Granite"),
         ("llama2", "Llama2"),
         ("llama3", "Llama3"),
         ("llava", "LLaVa"),

src/transformers/models/auto/modeling_auto.py

@@ -135,6 +135,7 @@
         ("levit", "LevitModel"),
         ("lilt", "LiltModel"),
         ("llama", "LlamaModel"),
+        ("granite", "GraniteModel"),
         ("longformer", "LongformerModel"),
         ("longt5", "LongT5Model"),
         ("luke", "LukeModel"),
@@ -463,6 +464,7 @@
         ("jamba", "JambaForCausalLM"),
         ("jetmoe", "JetMoeForCausalLM"),
         ("llama", "LlamaForCausalLM"),
+        ("granite", "GraniteForCausalLM"),
         ("mamba", "MambaForCausalLM"),
         ("marian", "MarianForCausalLM"),
         ("mbart", "MBartForCausalLM"),
@@ -873,6 +875,7 @@
         ("led", "LEDForSequenceClassification"),
         ("lilt", "LiltForSequenceClassification"),
         ("llama", "LlamaForSequenceClassification"),
+        ("granite", "GraniteForSequenceClassification"),
         ("longformer", "LongformerForSequenceClassification"),
         ("luke", "LukeForSequenceClassification"),
         ("markuplm", "MarkupLMForSequenceClassification"),
@@ -955,6 +958,7 @@
         ("led", "LEDForQuestionAnswering"),
         ("lilt", "LiltForQuestionAnswering"),
         ("llama", "LlamaForQuestionAnswering"),
+        ("granite", "GraniteForQuestionAnswering"),
         ("longformer", "LongformerForQuestionAnswering"),
         ("luke", "LukeForQuestionAnswering"),
         ("lxmert", "LxmertForQuestionAnswering"),
@@ -1050,6 +1054,7 @@
         ("layoutlmv3", "LayoutLMv3ForTokenClassification"),
         ("lilt", "LiltForTokenClassification"),
         ("llama", "LlamaForTokenClassification"),
+        ("granite", "GraniteForTokenClassification"),
         ("longformer", "LongformerForTokenClassification"),
         ("luke", "LukeForTokenClassification"),
         ("markuplm", "MarkupLMForTokenClassification"),

src/transformers/models/granite/__init__.py

@@ -0,0 +1,63 @@
+# Copyright 2024 EleutherAI and The HuggingFace Inc. 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.
+from typing import TYPE_CHECKING
+
+from ...utils import (
+    OptionalDependencyNotAvailable,
+    _LazyModule,
+    is_torch_available,
+)
+
+
+_import_structure = {
+    "configuration_granite": ["GraniteConfig"],
+}
+
+try:
+    if not is_torch_available():
+        raise OptionalDependencyNotAvailable()
+except OptionalDependencyNotAvailable:
+    pass
+else:
+    _import_structure["modeling_granite"] = [
+        "GraniteForCausalLM",
+        "GraniteModel",
+        "GranitePreTrainedModel",
+        "GraniteForSequenceClassification",
+        "GraniteForQuestionAnswering",
+        "GraniteForTokenClassification",
+    ]
+
+if TYPE_CHECKING:
+    from .configuration_granite import GraniteConfig
+
+    try:
+        if not is_torch_available():
+            raise OptionalDependencyNotAvailable()
+    except OptionalDependencyNotAvailable:
+        pass
+    else:
+        from .modeling_granite import (
+            GraniteForCausalLM,
+            GraniteForQuestionAnswering,
+            GraniteForSequenceClassification,
+            GraniteForTokenClassification,
+            GraniteModel,
+            GranitePreTrainedModel,
+        )
+
+else:
+    import sys
+
+    sys.modules[__name__] = _LazyModule(__name__, globals()["__file__"], _import_structure, module_spec=__spec__)