[QEff. Finetune]: Adding base class and HF class by quic-swatia · Pull Request #658 · quic/efficient-transformers

quic-swatia · 2025-12-09T07:30:34Z

Added Base Model class and HF model class.
Base Model class will support FT for any custom model and will be a common skeleton for any model, including HF.
Added unit tests for these.

Signed-off-by: Swati Allabadi <sallabad@qti.qualcomm.com>

quic-meetkuma

Please use your reference code wisely. The implementation lacks main functionalities. The tests are not extensive and implemented in naive manner. Please correct them as well.

Reference code: https://github.com/quic-meetkuma/LightningLLMs/blob/hf_trainer/LightningLLM/components/model.py

quic-meetkuma · 2025-12-16T07:22:07Z

+        return self._model
+
+    @property
+    def tokenizer(self) -> Any:


This is applicable for NLP models. We can't put it in BaseClass. Better to create an abstract method called "preprocessor" which defines generic preprocessing function applicable for the model. There wont be any implementation here but the children class should implement that. In case of LLMs, this method should return tokenizer.

quic-meetkuma · 2025-12-16T07:22:54Z

+    @abstractmethod
+    def load_model(self) -> nn.Module:
+        """Create and return the underlying torch.nn.Module."""
+        ...


use "pass" as it is explicit.

Updated in latest, doesn't make any difference though. Both syntax are valid.

quic-meetkuma · 2025-12-16T07:50:58Z

+
+    # get_input_embeddings: underlying model lacks method, should warn and return None
+    with mock.patch("QEfficient.finetune.experimental.core.model.logger.info") as mocked_log:
+        assert m.get_input_embeddings() is None


create a proper dummy model which returns some embeddings rather than None. Your test should use HFModel class instead of some dummy class.

quic-meetkuma · 2025-12-16T07:52:50Z

+        raising=False,
+    )
+
+    m = HFModel.create("hf-name")


No need to call individual class's create method. There is a reason to use a registry functionality.

Purpose of create is different than component_registry. Explained in another comment.

Move it to ComponentFactory and then instantiate from there.

Replied above.

quic-meetkuma · 2025-12-16T07:54:13Z

+    tok = m.load_tokenizer()
+
+    # tokenizer was loaded and pad token inserted
+    model.AutoTokenizer.from_pretrained.assert_called_once_with("hf-name")


Dont write such tests filled with assert_called_once etc.. We have written such tests in past but that was not an appropriate thing. It was a makeshift arrangement because of monolith structure of code. Write extensive and proper tests. If a function has made some changes to the model's structure then use that to test rather then counting how many times the function gets called.

quic-meetkuma · 2025-12-16T08:07:53Z

+
+
+@registry.model("hf")
+class HFModel(BaseModel):


We need to load the model based on configuration as well. That is mainly for testing purpose. In integration tests we will not load an entire model consists of 32 layers. But we will only load the same model with 2 or 4 layers and do further testing. For that purpose config should be used to load the model. Check huggingface documentation on how to do that.

Signed-off-by: Swati Allabadi <sallabad@qti.qualcomm.com>

- Added Base Model class and HF model class. - Base Model class will support FT for any custom model and will be a common skeleton for any model, including any HF model. - Added unit tests for these. --------- Signed-off-by: Swati Allabadi <sallabad@qti.qualcomm.com> Co-authored-by: Swati Allabadi <sallabad@qti.qualcomm.com>

- Added Base Model class and HF model class. - Base Model class will support FT for any custom model and will be a common skeleton for any model, including any HF model. - Added unit tests for these. --------- Signed-off-by: Swati Allabadi <sallabad@qti.qualcomm.com> Co-authored-by: Swati Allabadi <sallabad@qti.qualcomm.com> Signed-off-by: Sharvari Medhe <smedhe@qti.qualcomm.com>

- Added Base Model class and HF model class. - Base Model class will support FT for any custom model and will be a common skeleton for any model, including any HF model. - Added unit tests for these. --------- Signed-off-by: Swati Allabadi <sallabad@qti.qualcomm.com> Co-authored-by: Swati Allabadi <sallabad@qti.qualcomm.com> Signed-off-by: Sharvari Medhe <smedhe@qti.qualcomm.com> Signed-off-by: Sharvari Medhe <smedhe@qti.qualcomm.com>

- Added Base Model class and HF model class. - Base Model class will support FT for any custom model and will be a common skeleton for any model, including any HF model. - Added unit tests for these. --------- Signed-off-by: Swati Allabadi <sallabad@qti.qualcomm.com> Co-authored-by: Swati Allabadi <sallabad@qti.qualcomm.com> Signed-off-by: Sharvari Medhe <smedhe@qti.qualcomm.com>

- Added Base Model class and HF model class. - Base Model class will support FT for any custom model and will be a common skeleton for any model, including any HF model. - Added unit tests for these. --------- Signed-off-by: Swati Allabadi <sallabad@qti.qualcomm.com> Co-authored-by: Swati Allabadi <sallabad@qti.qualcomm.com>

- Added Base Model class and HF model class. - Base Model class will support FT for any custom model and will be a common skeleton for any model, including any HF model. - Added unit tests for these. --------- Signed-off-by: Swati Allabadi <sallabad@qti.qualcomm.com> Co-authored-by: Swati Allabadi <sallabad@qti.qualcomm.com> Signed-off-by: Sharvari Medhe <smedhe@qti.qualcomm.com>

Adding base class and Hf class

f88f01d

Signed-off-by: Swati Allabadi <sallabad@qti.qualcomm.com>

quic-swatia requested review from ochougul, quic-amitraj, quic-hemagnih and quic-rishinr as code owners December 9, 2025 07:30

quic-swatia requested review from quic-akuruvil, quic-meetkuma and vbaddi December 10, 2025 21:28

Adding unit test cases

defab15

Signed-off-by: Swati Allabadi <sallabad@qti.qualcomm.com>

quic-swatia force-pushed the model_classes_exp branch from a663197 to defab15 Compare December 10, 2025 21:36

quic-meetkuma requested changes Dec 16, 2025

View reviewed changes

Addressing review comments

51ae86a

Signed-off-by: Swati Allabadi <sallabad@qti.qualcomm.com>

quic-swatia marked this pull request as draft December 19, 2025 10:43

quic-swatia force-pushed the model_classes_exp branch 3 times, most recently from dddb4e7 to a963119 Compare December 25, 2025 01:01

Addressed review comments

7654e2e

Signed-off-by: Swati Allabadi <sallabad@qti.qualcomm.com>

quic-swatia force-pushed the model_classes_exp branch from a963119 to 7654e2e Compare December 25, 2025 01:05

quic-swatia marked this pull request as ready for review December 25, 2025 01:07

quic-swatia merged commit 866a140 into quic:ft_experimental Dec 25, 2025
3 checks passed

Conversation

quic-swatia commented Dec 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

quic-meetkuma left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

quic-swatia Dec 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

quic-swatia commented Dec 9, 2025 •

edited

Loading

quic-swatia Dec 19, 2025 •

edited

Loading