stouputils 1.2.42__tar.gz → 1.2.44__tar.gz

{stouputils-1.2.42 → stouputils-1.2.44}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stouputils
-Version: 1.2.42
+Version: 1.2.44
 Summary: Stouputils is a collection of utility modules designed to simplify and enhance the development process. It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers, and many more.
 Project-URL: Homepage, https://github.com/Stoupy51/stouputils
 Project-URL: Issues, https://github.com/Stoupy51/stouputils/issues

{stouputils-1.2.42 → stouputils-1.2.44}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "stouputils"
-version = "1.2.42"
+version = "1.2.44"
 description = "Stouputils is a collection of utility modules designed to simplify and enhance the development process. It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers, and many more."
 readme = "README.md"
 requires-python = ">=3.10"

{stouputils-1.2.42 → stouputils-1.2.44}/stouputils/data_science/config/set.py

@@ -24,13 +24,13 @@ class DataScienceConfig:
 	""" Log level for errors for all functions. """
 
 	AUGMENTED_FILE_SUFFIX: str = "_aug_"
-	""" Suffix for augmented files, ex: 'image_008_aug_1.png'. """
+	""" Suffix for augmented files, e.g. 'image_008_aug_1.png'. """
 
 	AUGMENTED_DIRECTORY_PREFIX: str = "aug_"
-	""" Prefix for augmented directories, ex: 'data/hip_implant' -> 'data/aug_hip_implant'. """
+	""" Prefix for augmented directories, e.g. 'data/hip_implant' -> 'data/aug_hip_implant'. """
 
 	PREPROCESSED_DIRECTORY_SUFFIX: str = "_preprocessed"
-	""" Suffix for preprocessed directories, ex: 'data/hip_implant' -> 'data/hip_implant_preprocessed'. """
+	""" Suffix for preprocessed directories, e.g. 'data/hip_implant' -> 'data/hip_implant_preprocessed'. """
 
 
 	# Directories

{stouputils-1.2.42 → stouputils-1.2.44}/stouputils/data_science/data_processing/technique.py

@@ -104,7 +104,7 @@ class ProcessingTechnique(NamedTuple):
 	Should be used on techniques like "axis_flip" or "random_erase"
 	where the probability of applying the technique is not 100%. """
 	custom: Callable[..., NDArray[Any]] | None = None
-	""" Custom processing technique (callable), name must be "custom", ex: ProcessingTechnique("custom", custom=f) """
+	""" Custom processing technique (callable), name must be "custom", e.g. ProcessingTechnique("custom", custom=f) """
 
 	def __str__(self) -> str:
 		return (

{stouputils-1.2.42 → stouputils-1.2.44}/stouputils/data_science/dataset/image_loader.py

@@ -74,7 +74,7 @@ def load_images_from_directory(
 
 		# Add channel dimension if grayscale
 		if is_grayscale:
-			img_array = np.expand_dims(img_array, axis=-1)  # Add channel dimension, ex: (224, 224, 1)
+			img_array = np.expand_dims(img_array, axis=-1)  # Add channel dimension, e.g. (224, 224, 1)
 
 		return img_array, img_path
 

{stouputils-1.2.42 → stouputils-1.2.44}/stouputils/data_science/dataset/xy_tuple.py

@@ -125,7 +125,7 @@ class XyTuple(tuple[list[list[Any]], list[Any], tuple[tuple[str, ...], ...]]):
 		self.filepaths: tuple[tuple[str, ...], ...] = self[2]
 		""" List of filepaths corresponding to the features (one file = list with one element) """
 		self.augmented_files: dict[str, str] = self.update_augmented_files()
-		""" Dictionary mapping all files to their original filepath, ex: {"file1_aug_1.jpg": "file1.jpg"} """
+		""" Dictionary mapping all files to their original filepath, e.g. {"file1_aug_1.jpg": "file1.jpg"} """
 
 	@property
 	def n_samples(self) -> int:

{stouputils-1.2.42 → stouputils-1.2.44}/stouputils/data_science/models/keras_utils/callbacks/progressive_unfreezing.py

@@ -41,7 +41,7 @@ class ProgressiveUnfreezing(Callback):
 			reset_weights      (bool):    If True, reset weights after each unfreeze.
 			reset_optimizer_function (Callable | None):
 				If set, use this function to reset the optimizer every update_interval.
-				The function should return a compiled optimizer, ex: `lambda: model._get_optimizer(AdamW(...))`.
+				The function should return a compiled optimizer, e.g. `lambda: model._get_optimizer(AdamW(...))`.
 			update_per_epoch   (bool):    If True, unfreeze per epoch, else per batch.
 			update_interval    (int):     Number of steps between each unfreeze to allow model to stabilize.
 			progressive_freeze (bool):    If True, start with all layers unfrozen and progressively freeze them.

{stouputils-1.2.42 → stouputils-1.2.44}/stouputils/data_science/models/model_interface.py

@@ -386,7 +386,7 @@ class ModelInterface(AbstractModel):
 			return mlflow_utils.get_weights_path(from_string=str(run.info.artifact_uri))
 
 	def _get_total_layers(self) -> int:
-		""" Get the total number of layers in the model architecture, ex: 427 for DenseNet121.
+		""" Get the total number of layers in the model architecture, e.g. 427 for DenseNet121.
 
 		Compatible with Keras/TensorFlow and PyTorch models.
 
@@ -465,7 +465,7 @@ class ModelInterface(AbstractModel):
 		Args:
 			y_train (NDArray[Any]): Training labels
 		Returns:
-			dict[int, float]: Dictionary mapping class indices to weights, ex: {0: 0.34, 1: 0.66}
+			dict[int, float]: Dictionary mapping class indices to weights, e.g. {0: 0.34, 1: 0.66}
 		"""
 		# Get the true classes (one-hot -> class indices)
 		true_classes: NDArray[Any] = Utils.convert_to_class_indices(y_train)

{stouputils-1.2.42 → stouputils-1.2.44}/stouputils/data_science/scripts/exhaustive_process.py

@@ -47,8 +47,8 @@ def exhaustive_process(
 
 	Args:
 		datasets_to_process (list[tuple[str, str]]): List of dataset paths to process.
-			Each tuple contains (dataset_path, based_of_path), ex: [("aug_preprocessed_path", "preprocessed_path")].
-		main_script_path (str): Path to the main script, ex: "src/main.py"
+			Each tuple contains (dataset_path, based_of_path), e.g. [("aug_preprocessed_path", "preprocessed_path")].
+		main_script_path (str): Path to the main script, e.g. "src/main.py"
 		default_model (str): Default model architecture to use for training.
 		default_kfold (int): Default number of folds for k-fold cross validation.
 		default_transfer_learning (str): Default source for transfer learning.

{stouputils-1.2.42 → stouputils-1.2.44}/stouputils/data_science/scripts/routine.py

@@ -13,8 +13,8 @@ from ..models.all import ALL_MODELS, CLASS_MAP, ModelInterface
 
 # Constants
 MODEL_HELP: str             = "Model(s) name or alias to use"
-INPUT_HELP: str             = "Path to the dataset, ex: 'data/aug_hip_implant'"
-BASED_OF_HELP: str          = "Path to the base dataset for filtering train/test, ex: 'data/hip_implant'"
+INPUT_HELP: str             = "Path to the dataset, e.g. 'data/aug_hip_implant'"
+BASED_OF_HELP: str          = "Path to the base dataset for filtering train/test, e.g. 'data/hip_implant'"
 TRANSFER_LEARNING_HELP: str = "Transfer learning source (imagenet, None, 'data/dataset_folder')"
 GROUPING_HELP: str          = "Grouping strategy for the dataset"
 K_FOLD_HELP: str            = "Number of folds for k-fold cross validation (0 = no k-fold, negative = LeavePOut)"