fix: Simplify docstrings for inherited methods in ModelConfig and TrainingArguments

Author: selimfirat

examples/data/plot_data_generation.py

@@ -27,7 +27,7 @@
 # 1. Basic Dataset Generation
 # ---------------------------------------------------------
 # Binary and Uniform Dataset Creation
-# ==================================
+# ========================================================
 #
 # Let's start with the basic dataset generation functions using HuggingFace datasets.
 # These functions create datasets with specific distributions.
@@ -171,7 +171,7 @@ def process_batch(dataset, batch_size=10):
 # 4. Communication Channel Simulation
 # ---------------------------------------------------------
 # Binary Symmetric Channel Example
-# ===============================
+# ========================================
 #
 # Let's simulate a simple binary symmetric channel using
 # the generated binary data.

kaira/models/base.py

@@ -573,3 +573,21 @@ def __init__(self, hidden_dim: int = 256, **kwargs):
         """
         super().__init__(**kwargs)
         self.hidden_dim = hidden_dim
+
+    # Override inherited methods with problematic docstrings to provide clean documentation
+    @classmethod
+    def from_pretrained(cls, *args, **kwargs):
+        """Create configuration from pretrained model.
+
+        This method loads configuration from a pretrained model. Inherited from
+        transformers.PretrainedConfig with simplified documentation.
+        """
+        return super().from_pretrained(*args, **kwargs)
+
+    def push_to_hub(self, *args, **kwargs):
+        """Push configuration to Hugging Face Hub.
+
+        This method uploads the configuration to Hugging Face Hub. Inherited from
+        transformers.PretrainedConfig with simplified documentation.
+        """
+        return super().push_to_hub(*args, **kwargs)

kaira/training/arguments.py

@@ -265,3 +265,76 @@ def get_snr_range(self) -> tuple:
     def get_noise_variance_range(self) -> tuple:
         """Get noise variance range as tuple."""
         return (self.noise_variance_min, self.noise_variance_max)
+
+    # Override inherited methods with problematic docstrings to provide clean documentation
+    def set_dataloader(self, *args, **kwargs):
+        """Set dataloader configuration.
+
+        This method configures dataloader settings for training. Inherited from
+        transformers.TrainingArguments with simplified documentation.
+        """
+        return super().set_dataloader(*args, **kwargs)
+
+    def set_evaluate(self, *args, **kwargs):
+        """Set evaluation configuration.
+
+        This method configures evaluation settings for training. Inherited from
+        transformers.TrainingArguments with simplified documentation.
+        """
+        return super().set_evaluate(*args, **kwargs)
+
+    def set_logging(self, *args, **kwargs):
+        """Set logging configuration.
+
+        This method configures logging settings for training. Inherited from
+        transformers.TrainingArguments with simplified documentation.
+        """
+        return super().set_logging(*args, **kwargs)
+
+    def set_lr_scheduler(self, *args, **kwargs):
+        """Set learning rate scheduler configuration.
+
+        This method configures learning rate scheduler settings. Inherited from
+        transformers.TrainingArguments with simplified documentation.
+        """
+        return super().set_lr_scheduler(*args, **kwargs)
+
+    def set_optimizer(self, *args, **kwargs):
+        """Set optimizer configuration.
+
+        This method configures optimizer settings for training. Inherited from
+        transformers.TrainingArguments with simplified documentation.
+        """
+        return super().set_optimizer(*args, **kwargs)
+
+    def set_push_to_hub(self, *args, **kwargs):
+        """Set push to hub configuration.
+
+        This method configures settings for pushing models to Hugging Face Hub. Inherited from
+        transformers.TrainingArguments with simplified documentation.
+        """
+        return super().set_push_to_hub(*args, **kwargs)
+
+    def set_save(self, *args, **kwargs):
+        """Set save configuration.
+
+        This method configures model saving settings. Inherited from transformers.TrainingArguments
+        with simplified documentation.
+        """
+        return super().set_save(*args, **kwargs)
+
+    def set_testing(self, *args, **kwargs):
+        """Set testing configuration.
+
+        This method configures testing settings. Inherited from transformers.TrainingArguments with
+        simplified documentation.
+        """
+        return super().set_testing(*args, **kwargs)
+
+    def set_training(self, *args, **kwargs):
+        """Set training configuration.
+
+        This method configures training settings. Inherited from transformers.TrainingArguments
+        with simplified documentation.
+        """
+        return super().set_training(*args, **kwargs)