Fix typos in comments and docstrings (#1148)

Author: maxtaran2010

skorch/_doctor.py

@@ -72,7 +72,7 @@ def add_activation_hooks(net, match_fn=None):
 
     If an output is not a simple array, it is disambiguated. E.g. if it's a
     list, the name get a suffix of ``[i]`` where ``i`` designates the index in
-    the list. Similary, when the output is a dict, a ``[key]`` suffix is added,
+    the list. Similarly, when the output is a dict, a ``[key]`` suffix is added,
     where ``[key]`` is the key of the corresponding value in the dictionary.
 
     Parameters
@@ -249,7 +249,7 @@ class SkorchDoctor(BaseEstimator):
           different parameter groups, or an adaptive optimizer like Adam.
 
         - If gradients are too big, consider using gradient clipping. If the
-          mangitude of gradients shifts over time, you might want to use a
+          magnitude of gradients shifts over time, you might want to use a
           learning rate scheduler.
 
     At the end of the day, ``SkorchDoctor`` will not tell you what you need to
@@ -333,7 +333,7 @@ class SkorchDoctor(BaseEstimator):
 
       If an activation is not a simple array, it is disambiguated. E.g. if it's a
       list, the name get a suffix of ``[i]`` where ``i`` designates the index in
-      the list. Similary, when the output is a dict, a ``[key]`` suffix is
+      the list. Similarly, when the output is a dict, a ``[key]`` suffix is
       added, where ``[key]`` is the key of the corresponding value in the
       dictionary.
 

skorch/callbacks/logging.py

@@ -387,7 +387,7 @@ class PrintLog(Callback):
 
     ``PrintLog`` treats keys with the ``'event_'`` prefix in a special
     way. They are assumed to contain information about occasionally
-    occuring events. The ``False`` or ``None`` entries (indicating
+    occurring events. The ``False`` or ``None`` entries (indicating
     that an event did not occur) are not printed, resulting in empty
     cells in the table, and ``True`` entries are printed with ``+``
     symbol. ``PrintLog`` groups all event columns together and pushes
@@ -689,7 +689,7 @@ class TensorBoard(Callback):
     """Logs results from history to TensorBoard
 
     "TensorBoard provides the visualization and tooling needed for machine
-    learning experimentation" (`offical docs
+    learning experimentation" (`official docs
     <https://www.tensorflow.org/tensorboard/>`_).
 
     Use this callback to automatically log all interesting values from your

skorch/callbacks/scoring.py

@@ -167,7 +167,7 @@ class BatchScoring(ScoringBase):
     the score for each batch and then averages the score at the end of
     the epoch. This can be disadvantageous for some scores if the
     batch size is small -- e.g. area under the ROC will return
-    incorrect scores in this case. Therefore, it is recommnded to use
+    incorrect scores in this case. Therefore, it is recommended to use
     :class:`.EpochScoring` unless you really need the scores for each
     batch.
 

skorch/classifier.py

@@ -42,7 +42,7 @@
 """
 
 def get_neural_net_clf_doc(doc):
-    # dedent/indent roundtrip required for consistent indention in both
+    # dedent/indent roundtrip required for consistent indentation in both
     # Python <3.13 and Python >=3.13
     # Because <3.13 => no automatic dedent, but it is the case in >=3.13
     indentation = "    "
@@ -255,7 +255,7 @@ def predict(self, X):
       is used by ``predict`` and ``predict_proba`` for classification."""
 
 def get_neural_net_binary_clf_doc(doc):
-    # dedent/indent roundtrip required for consistent indention in both
+    # dedent/indent roundtrip required for consistent indentation in both
     # Python <3.13 and Python >=3.13
     # Because <3.13 => no automatic dedent, but it is the case in >=3.13
     indentation = "    "

skorch/cli.py

@@ -258,7 +258,7 @@ def print_help(model, defaults=None):
     model : sklearn.base.BaseEstimator
       The basic model, e.g. a ``NeuralNet`` or sklearn ``Pipeline``.
 
-    defautls : dict or None (default=None)
+    defaults : dict or None (default=None)
       Optionally, change the default values to use custom
       defaults. Commandline arguments have precedence over defaults.
 

skorch/dataset.py

@@ -172,7 +172,7 @@ def transform(self, X, y):
         By default, they are cast to PyTorch :class:`~torch.Tensor`\s.
         Override this if you want a different behavior.
 
-        Note: If you use this in conjuction with PyTorch
+        Note: If you use this in conjunction with PyTorch
         :class:`~torch.utils.data.DataLoader`, the latter will call
         the dataset for each row separately, which means that the
         incoming ``X`` and ``y`` each are single rows.

skorch/helper.py

@@ -219,7 +219,7 @@ def shape(self):
     def transform(self, data):
         """Additional transformations on ``data``.
 
-        Note: If you use this in conjuction with PyTorch
+        Note: If you use this in conjunction with PyTorch
         :class:`~torch.utils.data.DataLoader`, the latter will call
         the dataset for each row separately, which means that the
         incoming ``data`` is a single rows.

skorch/hf.py

@@ -851,7 +851,7 @@ class was added: Using this mixin in conjunction with the accelerate library
 
     .. warning::
 
-        Since accelerate is still quite young and backwards compatiblity
+        Since accelerate is still quite young and backwards compatibility
         breaking features might be added, we treat its integration as an
         experimental feature. When accelerate's API stabilizes, we will consider
         adding it to skorch proper.
@@ -1021,7 +1021,7 @@ def get_iterator(self, *args, **kwargs):
 
     def _step_optimizer(self, step_fn):
         # We cannot step_fn as a 'closure' to .step because GradScaler doesn't
-        # suppor it:
+        # support it:
         # https://pytorch.org/docs/stable/amp.html#torch.cuda.amp.GradScaler.step
         # Therefore, we need to call step_fn explicitly and step without
         # argument.
@@ -1132,7 +1132,7 @@ class HfHubStorage:
 
     Note that writes to the Hub are synchronous. Therefore, if the time it takes
     to upload the data is long compared to training the model, there can be a
-    signficant slowdown. It is best to use this with
+    significant slowdown. It is best to use this with
     :class:`skorch.callbacks.training.TrainEndCheckpoint`, as that checkpoint
     only uploads the data once, at the end of training. Also, using this writer
     with :class:`skorch.callbacks.training.LoadInitState` is not supported for

skorch/llm/classifier.py

@@ -393,7 +393,7 @@ def _fit(self, X, y, **fit_params):
     def _predict_one(self, text):
         """Make a prediction for a single sample
 
-        The returned probabilites are *not normalized* yet.
+        The returned probabilities are *not normalized* yet.
 
         Raises a ``LowProbabilityError`` if the total probability of all labels
         is 0, or, assuming ``error_low_prob`` is ``'raise'``, when it is below
@@ -534,7 +534,7 @@ class will be replaced by ``None`` if the sum of the probabilities is
           The label for each class.
 
         """
-        # y_proba not normalized but it's not neeeded here
+        # y_proba not normalized but it's not needed here
         y_proba = self._predict_proba(X)
         pred_ids = y_proba.argmax(1)
         y_pred = self.classes_[pred_ids]
@@ -704,7 +704,7 @@ class ZeroShotClassifier(_LlmBase):
     ----------
     classes_ : ndarray of shape (n_classes, )
       A list of class labels known to the classifier. This attribute can be used
-      to identify which column in the probabilties returned by ``predict_proba``
+      to identify which column in the probabilities returned by ``predict_proba``
       corresponds to which class.
 
     """
@@ -932,7 +932,7 @@ class FewShotClassifier(_LlmBase):
     ----------
     classes_ : ndarray of shape (n_classes, )
       A list of class labels known to the classifier. This attribute can be used
-      to identify which column in the probabilties returned by ``predict_proba``
+      to identify which column in the probabilities returned by ``predict_proba``
       corresponds to which class.
 
     """

skorch/net.py

@@ -1,7 +1,7 @@
 """Neural net base class
 
 This is the most flexible class, not making assumptions on the kind of
-task being peformed. Subclass this to create more specialized and
+task being performed. Subclass this to create more specialized and
 sklearn-conforming classes like NeuralNetClassifier.
 
 """
@@ -144,7 +144,7 @@ class NeuralNet(BaseEstimator):
       this if your data is not supported. You should generally pass the
       uninitialized ``Dataset`` class and define additional arguments to
       X and y by prefixing them with ``dataset__``. It is also possible
-      to pass an initialzed ``Dataset``, in which case no additional
+      to pass an initialized ``Dataset``, in which case no additional
       arguments may be passed.
 
     train_split : None or callable (default=skorch.dataset.ValidSplit(5))
@@ -700,7 +700,7 @@ def initialize_history(self):
         return self
 
     def _format_reinit_msg(self, name, kwargs=None, triggered_directly=True):
-        """Returns a message that informs about re-initializing a compoment.
+        """Returns a message that informs about re-initializing a component.
 
         Sometimes, the module or optimizer need to be
         re-initialized. Not only should the user receive a message
@@ -1593,7 +1593,7 @@ def forward_iter(self, X, training=False, device='cpu'):
 
         device : string (default='cpu')
           The device to store each inference result on.
-          This defaults to CPU memory since there is genereally
+          This defaults to CPU memory since there is generally
           more memory available there. For performance reasons
           this might be changed to a specific CUDA device,
           e.g. 'cuda:0'.
@@ -1641,7 +1641,7 @@ def forward(self, X, training=False, device='cpu'):
 
         device : string (default='cpu')
           The device to store each inference result on.
-          This defaults to CPU memory since there is genereally
+          This defaults to CPU memory since there is generally
           more memory available there. For performance reasons
           this might be changed to a specific CUDA device,
           e.g. 'cuda:0'.
@@ -2350,7 +2350,7 @@ def _set_params_callback(self, **params):
             if '__' not in name and name in names:
                 self._replace_callback(name, params.pop(key))
 
-        # 3. Step parameters and other initilisation arguments
+        # 3. Step parameters and other initialisation arguments
         for key in params.copy():
             name = key[11:]
             part0, part1 = name.split('__')
@@ -2527,12 +2527,12 @@ def _check_settable_attr(self, name, attr):
 
         """
         if (self.init_context_ is None) and isinstance(attr, torch.nn.Module):
-            msg = ("Trying to set torch compoment '{}' outside of an initialize method."
+            msg = ("Trying to set torch component '{}' outside of an initialize method."
                    " Consider defining it inside 'initialize_module'".format(name))
             raise SkorchAttributeError(msg)
 
         if (self.init_context_ is None) and isinstance(attr, torch.optim.Optimizer):
-            msg = ("Trying to set torch compoment '{}' outside of an initialize method."
+            msg = ("Trying to set torch component '{}' outside of an initialize method."
                    " Consider defining it inside 'initialize_optimizer'".format(name))
             raise SkorchAttributeError(msg)