pyerualjetwork 4.8__py3-none-any.whl → 5__py3-none-any.whl

pyerualjetwork/__init__.py

@@ -1,4 +1,44 @@
-__version__ = "4.8"
+""" 
+
+PyerualJetwork
+==============
+PyereualJetwork is a large, GPU-accelerated machine learning library in Python designed for professionals and researchers.
+It features PLAN, MLP, and Deep Learning training, as well as ENE (Eugenic NeuroEvolution) for genetic optimization, 
+which can also be applied to genetic algorithms or Reinforcement Learning (RL) problems. 
+The library includes functions for data pre-processing, visualizations, model saving and loading, prediction and evaluation, 
+training, and both detailed and simplified memory management.
+
+
+Library (CPU) Main Modules:
+---------------------------
+- neu
+- ene
+- data_operations
+- model_operations
+
+Library (GPU) Main Modules:
+---------------------------
+- neu_cuda
+- ene_cuda
+- data_operations_cuda
+- model_operations_cuda
+
+Memory Module:
+--------------
+- memory_operations
+
+Examples: https://github.com/HCB06/PyerualJetwork/tree/main/Welcome_to_PyerualJetwork/ExampleCodes
+
+PyerualJetwork document: https://github.com/HCB06/Anaplan/blob/main/Welcome_to_Anaplan/ANAPLAN_USER_MANUEL_AND_LEGAL_INFORMATION(EN).pdf
+
+- Author: Hasan Can Beydili
+- YouTube: https://www.youtube.com/@HasanCanBeydili
+- Linkedin: https://www.linkedin.com/in/hasan-can-beydili-77a1b9270/
+- Instagram: https://www.instagram.com/canbeydilj
+- Contact: tchasancan@gmail.com
+"""
+
+__version__ = "5"
 __update__ = """* Changes: https://github.com/HCB06/PyerualJetwork/blob/main/CHANGES
 * PyerualJetwork Homepage: https://github.com/HCB06/PyerualJetwork/tree/main
 * PyerualJetwork document: https://github.com/HCB06/PyerualJetwork/blob/main/Welcome_to_PyerualJetwork/PYERUALJETWORK_USER_MANUEL_AND_LEGAL_INFORMATION(EN).pdf

pyerualjetwork/data_operations.py

@@ -1,3 +1,33 @@
+""" 
+
+
+Data Operations
+===============
+This module contains functions for handling all operational processes related to data and datasets.
+
+Module functions:
+-----------------
+- encode_one_hot()
+- decode_one_hot()
+- split()
+- manuel_balancer()
+- auto_balancer()
+- synthetic_augmentation()
+- non_neg_normalization()
+- normalization()
+- standard_scaler()
+
+Examples: https://github.com/HCB06/PyerualJetwork/tree/main/Welcome_to_PyerualJetwork/ExampleCodes
+
+PyerualJetwork document: https://github.com/HCB06/Anaplan/blob/main/Welcome_to_Anaplan/ANAPLAN_USER_MANUEL_AND_LEGAL_INFORMATION(EN).pdf
+
+- Author: Hasan Can Beydili
+- YouTube: https://www.youtube.com/@HasanCanBeydili
+- Linkedin: https://www.linkedin.com/in/hasan-can-beydili-77a1b9270/
+- Instagram: https://www.instagram.com/canbeydilj
+- Contact: tchasancan@gmail.com
+"""
+
 from tqdm import tqdm
 import numpy as np
 from colorama import Fore, Style
@@ -383,7 +413,7 @@ def non_neg_normalization(
     dtype=np.float32
 ):
     """
-    Normalizes the input data [0-1] range.
+    Normalizes the input data [0-1] range using max-abs normalization but non negative number.
     Args:
         Input (numpy): Input data to be normalized.
         dtype (numpy.dtype): Data type for the arrays. np.float32 by default. Example: np.float64 or np.float16.

pyerualjetwork/data_operations_cuda.py

@@ -1,3 +1,33 @@
+""" 
+
+
+Data Operations on GPU (CUDA)
+=============================
+This module contains functions for handling all operational processes related to data and datasets on GPU memory.
+
+Module functions:
+---------------
+- encode_one_hot()
+- decode_one_hot()
+- split()
+- manuel_balancer()
+- auto_balancer()
+- synthetic_augmentation()
+- non_neg_normalization()
+- normalization()
+- standard_scaler()
+
+Examples: https://github.com/HCB06/PyerualJetwork/tree/main/Welcome_to_PyerualJetwork/ExampleCodes
+
+PyerualJetwork document: https://github.com/HCB06/Anaplan/blob/main/Welcome_to_Anaplan/ANAPLAN_USER_MANUEL_AND_LEGAL_INFORMATION(EN).pdf
+
+- Author: Hasan Can Beydili
+- YouTube: https://www.youtube.com/@HasanCanBeydili
+- Linkedin: https://www.linkedin.com/in/hasan-can-beydili-77a1b9270/
+- Instagram: https://www.instagram.com/canbeydilj
+- Contact: tchasancan@gmail.com
+"""
+
 from tqdm import tqdm
 import cupy as cp
 from colorama import Fore, Style

pyerualjetwork/{planeat.py → ene.py}

@@ -1,15 +1,31 @@
 """ 
-MAIN MODULE FOR PLANEAT
+
+
+ENE (Eugenic NeuroEvolution)
+============================
+
+This module contains all the functions necessary for implementing and testing the ENE (Eugenic NeuroEvolution) algorithm.
+For more information about the ENE algorithm: https://github.com/HCB06/PyerualJetwork/blob/main/Welcome_to_PLAN/PLAN.pdf
+
+Module functions:
+-----------------
+- evolver()
+- define_genomes()
+- evaluate()
+- cross_over() 
+- mutation()
+- dominant_parent_selection()
+- second_parent_selection()
 
 Examples: https://github.com/HCB06/PyerualJetwork/tree/main/Welcome_to_PyerualJetwork/ExampleCodes
 
 PyerualJetwork document: https://github.com/HCB06/Anaplan/blob/main/Welcome_to_Anaplan/ANAPLAN_USER_MANUEL_AND_LEGAL_INFORMATION(EN).pdf
 
-@author: Hasan Can Beydili
-@YouTube: https://www.youtube.com/@HasanCanBeydili
-@Linkedin: https://www.linkedin.com/in/hasan-can-beydili-77a1b9270/
-@Instagram: https://www.instagram.com/canbeydilj
-@contact: tchasancan@gmail.com
+- Author: Hasan Can Beydili
+- YouTube: https://www.youtube.com/@HasanCanBeydili
+- Linkedin: https://www.linkedin.com/in/hasan-can-beydili-77a1b9270/
+- Instagram: https://www.instagram.com/canbeydilj
+- Contact: tchasancan@gmail.com
 """
 
 import numpy as np
@@ -22,7 +38,7 @@ from .data_operations import normalization, non_neg_normalization
 from .ui import loading_bars, initialize_loading_bar
 from .activation_functions import apply_activation, all_activations
 
-def define_genomes(input_shape, output_shape, population_size, hidden=0, neurons=None, activation_functions=None, dtype=np.float32):
+def define_genomes(input_shape, output_shape, population_size, neurons=[], activation_functions=[], dtype=np.float32):
    """
    Initializes a population of genomes, where each genome is represented by a set of weights 
    and an associated activation function. Each genome is created with random weights and activation 
@@ -36,17 +52,15 @@ def define_genomes(input_shape, output_shape, population_size, hidden=0, neurons
       
       population_size (int): The number of genomes (individuals) in the population.
 
-      hidden (int, optional): If you dont want train PLAN model this parameter represents a hidden layer count for MLP model. Default: 0 (PLAN)
+      neurons (list[int], optional): If you dont want train PLAN model this parameter represents neuron count of each hidden layer for MLP. Default: [] (PLAN)
 
-      neurons (list[int], optional): If you dont want train PLAN model this parameter represents neuron count of each hidden layer for MLP. Default: None (PLAN)
-
-      activation_functions (list[str], optional): If you dont want train PLAN model this parameter represents activation function of each hidden layer for MLP. Default: None (PLAN) NOTE: THIS EFFECTS HIDDEN LAYERS OUTPUT. NOT OUTPUT LAYER!
+      activation_functions (list[str], optional): If you dont want train PLAN model this parameter represents activation function of each hidden layer for MLP. Default: [] (PLAN) NOTE: THIS EFFECTS HIDDEN LAYERS OUTPUT. NOT OUTPUT LAYER!
 
       dtype (numpy.dtype): Data type for the arrays. np.float32 by default. Example: np.float64 or np.float16.
 
    Returns:
       tuple: A tuple containing:
-         - population_weights (numpy.ndarray): A 2D numpy array of shape (population_size, output_shape, input_shape) representing the 
+         - population_weights (numpy.ndarray[numpy.ndarray]): representing the 
             weight matrices for each genome.
          - population_activations (list): A list of activation functions applied to each genome.
    
@@ -56,6 +70,9 @@ def define_genomes(input_shape, output_shape, population_size, hidden=0, neurons
       The weights for each genome are then modified by applying the corresponding activation function 
       and normalized using the `normalization()` function. (Max abs normalization.)
    """
+
+   hidden = len(neurons)
+
    if hidden > 0:
       population_weights = np.empty((population_size, hidden + 1), dtype=object)
       population_activations = [[0] * (hidden) for _ in range(population_size)]
@@ -112,7 +129,7 @@ def define_genomes(input_shape, output_shape, population_size, hidden=0, neurons
 
 
 def evolver(weights, 
-            activation_potentiations,
+            activations,
             what_gen, 
             fitness,
             weight_evolve=True,
@@ -148,7 +165,7 @@ def evolver(weights,
       weights (numpy.ndarray): Array of weights for each genome. 
          (first returned value of define_genomes function)
       
-      activation_potentiations (list[str]): A list of activation functions for each genome. 
+      activations (list[str]): A list of activation functions for each genome. 
          (second returned value of define_genomes function) NOTE!: 'activation potentiations' for PLAN 'activation functions' for MLP.
       
       what_gen (int): The current generation number, used for informational purposes or logging.
@@ -242,7 +259,7 @@ def evolver(weights,
       tuple: A tuple containing:
          - weights (numpy.ndarray): The updated weights for the population after selection, crossover, and mutation. 
                                     The shape is (population_size, output_shape, input_shape).
-         - activation_potentiations (list): The updated list of activation functions for the population.
+         - activations (list): The updated list of activation functions for the population.
 
    Notes:
       - **Selection Process**: 
@@ -263,7 +280,7 @@ def evolver(weights,
 
    Example:
       ```python
-      weights, activation_potentiations = planeat.evolver(weights, activation_potentiations, 1, fitness, show_info=True, strategy='normal_selective', policy='aggressive')
+      weights, activations = ene.evolver(weights, activations, 1, fitness, show_info=True, strategy='normal_selective', policy='aggressive')
       ```
 
       - The function returns the updated weights and activations after processing based on the chosen strategy, policy, and mutation parameters.
@@ -327,7 +344,7 @@ def evolver(weights,
    fitness = fitness[sort_indices]
    weights = weights[sort_indices]
 
-   activation_potentiations = [activation_potentiations[i] for i in sort_indices]
+   activations = [activations[i] for i in sort_indices]
 
 ### GENOMES ARE DIVIDED INTO TWO GROUPS: GOOD GENOMES AND BAD GENOMES:
 
@@ -335,8 +352,8 @@ def evolver(weights,
    bad_weights = weights[:slice_center]
    best_weight = np.copy(good_weights[-1]) if is_mlp is False else copy.deepcopy(good_weights[-1])
 
-   good_activations = list(activation_potentiations[slice_center:])
-   bad_activations = list(activation_potentiations[:slice_center])
+   good_activations = list(activations[slice_center:])
+   bad_activations = list(activations[:slice_center])
    best_activations = good_activations[-1].copy() if isinstance(good_activations[-1], list) else good_activations[-1]
 
    
@@ -469,11 +486,11 @@ def evolver(weights,
    else:
       weights = np.vstack((child_W, mutated_W), dtype=dtype)
    
-   activation_potentiations = child_act + mutated_act
+   activations = child_act + mutated_act
 
    if save_best_genome:
       weights[0] = best_weight
-      activation_potentiations[0] = best_activations
+      activations[0] = best_activations
    
    ### INFO PRINTING CONSOLE
    
@@ -512,10 +529,10 @@ def evolver(weights,
       
    if weight_evolve is False: weights = origin_weights
 
-   return weights, activation_potentiations
+   return weights, activations
 
 
-def evaluate(Input, weights, activation_potentiations, is_mlp=False):
+def evaluate(Input, weights, activations, is_mlp=False):
    """
     Evaluates the performance of a population of genomes, applying different activation functions 
     and weights depending on whether reinforcement learning mode is enabled or not.
@@ -525,7 +542,7 @@ def evaluate(Input, weights, activation_potentiations, is_mlp=False):
                                                a genome (A list of input features for each genome, or a single set of input features for one genome).
         weights (list or numpy.ndarray): A list or 2D numpy array of weights corresponding to each genome 
                                          in `x_population`. This determines the strength of connections.
-        activation_potentiations (list or str): A list where each entry represents an activation function 
+        activations (list or str): A list where each entry represents an activation function 
                                                 or a potentiation strategy applied to each genome. If only one 
                                                 activation function is used, this can be a single string.
         is_mlp (bool, optional): Evaluate PLAN model or MLP model ? Default: False (PLAN)
@@ -536,7 +553,7 @@ def evaluate(Input, weights, activation_potentiations, is_mlp=False):
 
     Example:
         ```python
-        outputs = evaluate(Input, weights, activation_potentiations)
+        outputs = evaluate(Input, weights, activations)
         ```
 
     - The function returns a list of outputs after processing the population, where each element corresponds to
@@ -544,16 +561,16 @@ def evaluate(Input, weights, activation_potentiations, is_mlp=False):
    """
    ### THE OUTPUTS ARE RETURNED, WHERE EACH GENOME'S OUTPUT MATCHES ITS INDEX:
    
-   if isinstance(activation_potentiations, str):
-      activation_potentiations = [activation_potentiations]
-   elif isinstance(activation_potentiations, list):
-      activation_potentiations = [item if isinstance(item, list) or isinstance(item, str) else [item] for item in activation_potentiations]
+   if isinstance(activations, str):
+      activations = [activations]
+   elif isinstance(activations, list):
+      activations = [item if isinstance(item, list) or isinstance(item, str) else [item] for item in activations]
 
 
    if is_mlp:
       layer = Input
       for i in range(len(weights)):
-         if i != len(weights) - 1 and i != 0: layer = apply_activation(layer, activation_potentiations[i])
+         if i != len(weights) - 1 and i != 0: layer = apply_activation(layer, activations[i])
 
          layer = layer @ weights[i].T
       
@@ -561,7 +578,7 @@ def evaluate(Input, weights, activation_potentiations, is_mlp=False):
 
    else:
 
-      Input = apply_activation(Input, activation_potentiations)
+      Input = apply_activation(Input, activations)
       result = Input @ weights.T
 
       return result

pyerualjetwork/{planeat_cuda.py → ene_cuda.py}

@@ -1,15 +1,31 @@
 """ 
-MAIN MODULE FOR PLANEAT
+
+
+ENE (Eugenic NeuroEvolution) on CUDA
+======================================
+
+This module contains all the functions necessary for implementing and testing the ENE (Eugenic NeuroEvolution) algorithm on CUDA GPU.
+For more information about the ENE algorithm: https://github.com/HCB06/PyerualJetwork/blob/main/Welcome_to_PLAN/PLAN.pdf
+
+Module functions:
+-----------------
+- evolver()
+- define_genomes()
+- evaluate()
+- cross_over() 
+- mutation()
+- dominant_parent_selection()
+- second_parent_selection()
 
 Examples: https://github.com/HCB06/PyerualJetwork/tree/main/Welcome_to_PyerualJetwork/ExampleCodes
 
 PyerualJetwork document: https://github.com/HCB06/Anaplan/blob/main/Welcome_to_Anaplan/ANAPLAN_USER_MANUEL_AND_LEGAL_INFORMATION(EN).pdf
 
-@author: Hasan Can Beydili
-@YouTube: https://www.youtube.com/@HasanCanBeydili
-@Linkedin: https://www.linkedin.com/in/hasan-can-beydili-77a1b9270/
-@Instagram: https://www.instagram.com/canbeydilj
-@contact: tchasancan@gmail.com
+- Author: Hasan Can Beydili
+- YouTube: https://www.youtube.com/@HasanCanBeydili
+- Linkedin: https://www.linkedin.com/in/hasan-can-beydili-77a1b9270/
+- Instagram: https://www.instagram.com/canbeydilj
+- Contact: tchasancan@gmail.com
 """
 
 import cupy as cp
@@ -23,7 +39,7 @@ from .data_operations_cuda import normalization, non_neg_normalization
 from .ui import loading_bars, initialize_loading_bar
 from .activation_functions_cuda import apply_activation, all_activations
 
-def define_genomes(input_shape, output_shape, population_size, hidden=0, neurons=None, activation_functions=None, dtype=cp.float32):
+def define_genomes(input_shape, output_shape, population_size, neurons=[], activation_functions=[], dtype=cp.float32):
    """
    Initializes a population of genomes, where each genome is represented by a set of weights 
    and an associated activation function. Each genome is created with random weights and activation 
@@ -36,8 +52,6 @@ def define_genomes(input_shape, output_shape, population_size, hidden=0, neurons
       output_shape (int): The number of output features for the neural network.
       
       population_size (int): The number of genomes (individuals) in the population.
-      
-      hidden (int, optional): If you dont want train PLAN model this parameter represents a hidden layer count for MLP model. Default: 0 (PLAN)
 
       neurons (list[int], optional): If you dont want train PLAN model this parameter represents neuron count of each hidden layer for MLP. Default: None (PLAN)
 
@@ -47,7 +61,7 @@ def define_genomes(input_shape, output_shape, population_size, hidden=0, neurons
 
    Returns:
       tuple: A tuple containing:
-         - population_weights (cupy.ndarray): A 2D numpy array of shape (population_size, output_shape, input_shape) representing the 
+         - population_weights (list[cupy.ndarray]): representing the 
             weight matrices for each genome.
          - population_activations (list): A list of activation functions applied to each genome.
             
@@ -57,6 +71,9 @@ def define_genomes(input_shape, output_shape, population_size, hidden=0, neurons
       The weights for each genome are then modified by applying the corresponding activation function 
       and normalized using the `normalization()` function. (Max abs normalization.)
    """
+   
+   hidden = len(neurons)
+
    if hidden > 0:
       population_weights = [[0] * (hidden + 1) for _ in range(population_size)]
       population_activations = [[0] * (hidden) for _ in range(population_size)]
@@ -112,7 +129,7 @@ def define_genomes(input_shape, output_shape, population_size, hidden=0, neurons
       return cp.array(population_weights, dtype=dtype), population_activations
 
 def evolver(weights, 
-            activation_potentiations, 
+            activations, 
             what_gen, 
             fitness,
             weight_evolve=True,
@@ -148,7 +165,7 @@ def evolver(weights,
       weights (cupy.ndarray): Array of weights for each genome. 
          (first returned value of define_genomes function)
       
-      activation_potentiations (list[str]): A list of activation functions for each genome. 
+      activations (list[str]): A list of activation functions for each genome. 
          (second returned value of define_genomes function) NOTE!: 'activation potentiations' for PLAN 'activation functions' for MLP.
       
       what_gen (int): The current generation number, used for informational purposes or logging.
@@ -242,7 +259,7 @@ def evolver(weights,
       tuple: A tuple containing:
          - weights (numpy.ndarray): The updated weights for the population after selection, crossover, and mutation. 
                                     The shape is (population_size, output_shape, input_shape).
-         - activation_potentiations (list): The updated list of activation functions for the population.
+         - activations (list): The updated list of activation functions for the population.
 
    Notes:
       - **Selection Process**: 
@@ -263,7 +280,7 @@ def evolver(weights,
 
    Example:
       ```python
-      weights, activation_potentiations = planeat_cuda.evolver(weights, activation_potentiations, 1, fitness, show_info=True, strategy='normal_selective', policy='aggressive')
+      weights, activations = ene_cuda.evolver(weights, activations, 1, fitness, show_info=True, strategy='normal_selective', policy='aggressive')
       ```
 
       - The function returns the updated weights and activations after processing based on the chosen strategy, policy, and mutation parameters.
@@ -336,7 +353,7 @@ def evolver(weights,
    fitness = fitness[sort_indices]
    weights = weights[sort_indices]
 
-   activation_potentiations = [activation_potentiations[int(i)] for i in sort_indices]
+   activations = [activations[int(i)] for i in sort_indices]
 
 ### GENOMES ARE DIVIDED INTO TWO GROUPS: GOOD GENOMES AND BAD GENOMES:
 
@@ -344,8 +361,8 @@ def evolver(weights,
    bad_weights = weights[:slice_center]
    best_weight = cp.copy(good_weights[-1])
 
-   good_activations = list(activation_potentiations[slice_center:])
-   bad_activations = list(activation_potentiations[:slice_center])
+   good_activations = list(activations[slice_center:])
+   bad_activations = list(activations[:slice_center])
    best_activations = good_activations[-1].copy() if isinstance(good_activations[-1], list) else good_activations[-1]
 
 
@@ -487,11 +504,11 @@ def evolver(weights,
    else:
       weights = cp.vstack((child_W, mutated_W), dtype=dtype)
 
-   activation_potentiations = child_act + mutated_act
+   activations = child_act + mutated_act
 
    if save_best_genome:
       weights[0] = best_weight
-      activation_potentiations[0] = best_activations
+      activations[0] = best_activations
 
    ### INFO PRINTING CONSOLE
    
@@ -529,10 +546,10 @@ def evolver(weights,
       
    if weight_evolve is False: weights = origin_weights
 
-   return weights, activation_potentiations
+   return weights, activations
 
 
-def evaluate(Input, weights, activation_potentiations, is_mlp=False):
+def evaluate(Input, weights, activations, is_mlp=False):
    """
     Evaluates the performance of a population of genomes, applying different activation functions 
     and weights depending on whether reinforcement learning mode is enabled or not.
@@ -544,7 +561,7 @@ def evaluate(Input, weights, activation_potentiations, is_mlp=False):
         weights (list or cupy.ndarray): A list or 2D numpy array of weights corresponding to each genome 
                                          in `x_population`. This determines the strength of connections.
         
-        activation_potentiations (list or str): A list where each entry represents an activation function 
+        activations (list or str): A list where each entry represents an activation function 
                                                 or a potentiation strategy applied to each genome. If only one 
                                                 activation function is used, this can be a single string.
         is_mlp (bool, optional): Evaluate PLAN model or MLP model ? Default: False (PLAN)
@@ -555,7 +572,7 @@ def evaluate(Input, weights, activation_potentiations, is_mlp=False):
 
     Example:
         ```python
-        outputs = evaluate(Input, weights, activation_potentiations)
+        outputs = evaluate(Input, weights, activations)
         ```
 
     - The function returns a list of outputs after processing the population, where each element corresponds to 
@@ -563,23 +580,23 @@ def evaluate(Input, weights, activation_potentiations, is_mlp=False):
    """
    ### THE OUTPUTS ARE RETURNED WHERE EACH GENOME'S OUTPUT MATCHES ITS INDEX:
    
-   if isinstance(activation_potentiations, str):
-    activation_potentiations = [activation_potentiations]
+   if isinstance(activations, str):
+    activations = [activations]
    else:
-    activation_potentiations = [item if isinstance(item, list) else [item] for item in activation_potentiations]
+    activations = [item if isinstance(item, list) else [item] for item in activations]
 
    if is_mlp:
       
       layer = Input
       for i in range(len(weights)):
-         if i != len(weights) - 1: layer = apply_activation(layer, activation_potentiations[i])
+         if i != len(weights) - 1: layer = apply_activation(layer, activations[i])
          layer = layer @ weights[i].T
       
       return layer
 
    else:
 
-      Input = apply_activation(Input, activation_potentiations)
+      Input = apply_activation(Input, activations)
       result = Input @ weights.T
 
       return result

pyerualjetwork/help.py

@@ -12,6 +12,6 @@ def activation_potentiation():
 def docs_and_examples():
 
     print('PLAN document: https://github.com/HCB06/Anaplan/tree/main/Welcome_to_PLAN\n')
-    print('PLAN examples: https://github.com/HCB06/Anaplan/tree/main/Welcome_to_Anaplan/ExampleCodes\n')
-    print('PLANEAT examples: https://github.com/HCB06/Anaplan/tree/main/Welcome_to_Anaplan/ExampleCodes/PLANEAT\n')
+    print('PLAN examples: https://github.com/HCB06/Anaplan/tree/main/Welcome_to_PyerualJetwork/ExampleCodes\n')
+    print('PLANEAT examples: https://github.com/HCB06/Anaplan/tree/main/Welcome_to_PyerualJetwork/ExampleCodes/ENE\n')
     print('Anaplan document and examples: https://github.com/HCB06/Anaplan/tree/main/Welcome_to_Anaplan')

pyerualjetwork/memory_operations.py

@@ -1,3 +1,29 @@
+""" 
+
+
+Memory Operations
+=================
+This module hosts functions for managing all operational processes related to memory management,
+including transferring data between CPU and GPU memory and retrieving memory information.
+
+Module functions:
+-----------------
+- get_available_cpu_memory()
+- transfer_to_cpu()
+- transfer_to_gpu()
+- optimize_labels()
+
+Examples: https://github.com/HCB06/PyerualJetwork/tree/main/Welcome_to_PyerualJetwork/ExampleCodes
+
+PyerualJetwork document: https://github.com/HCB06/Anaplan/blob/main/Welcome_to_Anaplan/ANAPLAN_USER_MANUEL_AND_LEGAL_INFORMATION(EN).pdf
+
+- Author: Hasan Can Beydili
+- YouTube: https://www.youtube.com/@HasanCanBeydili
+- Linkedin: https://www.linkedin.com/in/hasan-can-beydili-77a1b9270/
+- Instagram: https://www.instagram.com/canbeydilj
+- Contact: tchasancan@gmail.com
+"""
+
 import psutil
 import numpy as np
 import cupy as cp