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

pyerualjetwork/model_operations.py

@@ -1,3 +1,45 @@
+""" 
+
+
+Model Operations
+================
+This module hosts functions for handling all operational processes related to models, including:
+
+- Saving and loading models
+- Making predictions from memory
+- Making predictions from storage
+- Retrieving model weights
+- Retrieving model activation functions
+- Retrieving model accuracy
+- Running the model in reverse (applicable to PLAN models)
+
+Module functions:
+-----------------
+- save_model()
+- load_model()
+- predict_from_storage()
+- predict_from_memory()
+- reverse_predict_from_storage()
+- reverse_predict_from_memory()
+- get_weights()
+- get_act()
+- get_preds()
+- get_preds_softmax()
+- get_acc()
+- get_scaler()
+- get_model_type()
+
+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 numpy as np
 from colorama import Fore, Style
 import sys
@@ -14,7 +56,7 @@ def save_model(model_name,
                scaler_params=None,
                test_acc=None,
                model_path='',
-               activation_potentiation=['linear'],
+               activations=['linear'],
                weights_type='npy',
                weights_format='raw',
                show_architecture=False,
@@ -36,7 +78,7 @@ def save_model(model_name,
         
         model_path: (str): Path where the model will be saved. For example: C:/Users/beydili/Desktop/denemePLAN/ default: ''
         
-        activation_potentiation: (list[str]): For deeper PLAN networks, activation function parameters. Or activation function parameters for MLP layers. For more information please run this code: plan.activations_list() default: ['linear']
+        activations: (list[str]): For deeper PLAN networks, activation function parameters. Or activation function parameters for MLP layers. For more information please run this code: neu.activations_list() default: ['linear']
         
         weights_type: (str): Type of weights to save (options: 'txt', 'pkl', 'npy', 'mat'). default: 'npy'
         
@@ -55,12 +97,12 @@ def save_model(model_name,
     if model_type != 'PLAN' and model_type != 'MLP':
         raise ValueError("model_type parameter must be 'PLAN' or 'MLP'.")
 
-    if isinstance(activation_potentiation, str):
-        activation_potentiation = [activation_potentiation]
+    if isinstance(activations, str):
+        activations = [activations]
     else:
-        activation_potentiation = [item if isinstance(item, list) else [item] for item in activation_potentiation]
+        activations = [item if isinstance(item, list) else [item] for item in activations]
 
-    activation = activation_potentiation.copy()
+    activation = activations.copy()
 
     if test_acc != None:
         test_acc= float(test_acc)
@@ -145,7 +187,7 @@ def save_model(model_name,
             'WEIGHTS FORMAT': weights_format,
             'MODEL PATH': model_path,
             'STANDARD SCALER': scaler_params,
-            'ACTIVATION POTENTIATION': activation
+            'ACTIVATION FUNCTIONS': activation
             }
 
     df = pd.DataFrame(data)
@@ -242,9 +284,13 @@ def load_model(model_name,
 
         sys.exit()
 
-    activation_potentiation = list(df['ACTIVATION POTENTIATION'])
-    activation_potentiation = [x for x in activation_potentiation if not (isinstance(x, float) and np.isnan(x))]
-    activation_potentiation = [item for item in activation_potentiation if item != ''] 
+    try:
+        activations = list(df['ACTIVATION FUNCTIONS']) # for PyerualJetwork >=5 Versions.
+    except KeyError:
+        activations = list(df['ACTIVATION POTENTIATION']) # for PyerualJetwork <5 Versions.
+
+    activations = [x for x in activations if not (isinstance(x, float) and np.isnan(x))]
+    activations = [item for item in activations if item != ''] 
 
     scaler_params = df['STANDARD SCALER'].tolist()
     
@@ -280,14 +326,14 @@ def load_model(model_name,
     if WeightType == 'mat':
         W = W['w']
 
-    return W, None, None, activation_potentiation, scaler_params, None, model_type
+    return W, None, None, activations, scaler_params, None, model_type
 
 
 
-def predict_model_ssd(Input, model_name, model_path='', dtype=np.float32):
+def predict_from_storage(Input, model_name, model_path=''):
 
     """
-    Function to make a prediction using a potentiation learning artificial neural network (PLAN).
+    Function to make a prediction
     from storage
 
     Args:
@@ -296,8 +342,7 @@ def predict_model_ssd(Input, model_name, model_path='', dtype=np.float32):
         model_name (str): Name of the model.
         
         model_path (str): Path of the model. Default: ''
-        
-        dtype (numpy.dtype): Data type for the arrays. np.float32 by default. Example: np.float64, np.float16. (optional)
+    
     Returns:
         ndarray: Output from the model.
     """
@@ -309,15 +354,15 @@ def predict_model_ssd(Input, model_name, model_path='', dtype=np.float32):
 
         model = load_model(model_name, model_path)
         
-        activation_potentiation = model[get_act_pot()]
+        activations = model[get_act()]
         scaler_params = model[get_scaler()]
         W = model[get_weights()]
         model_type = model[get_model_type()]
 
-        if isinstance(activation_potentiation, str):
-            activation_potentiation = [activation_potentiation]
-        elif isinstance(activation_potentiation, list):
-            activation_potentiation = [item if isinstance(item, list) or isinstance(item, str) else [item] for item in activation_potentiation]
+        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]
             
         Input = standard_scaler(None, Input, scaler_params)
 
@@ -325,24 +370,24 @@ def predict_model_ssd(Input, model_name, model_path='', dtype=np.float32):
             
             layer = Input
             for i in range(len(W)):
-                if i != len(W) - 1 and i != 0: layer = apply_activation(layer, activation_potentiation[i])
+                if i != len(W) - 1 and i != 0: layer = apply_activation(layer, activations[i])
                 layer = layer @ W[i].T
             
             return layer
 
         else:
 
-            Input = apply_activation(Input, activation_potentiation)
+            Input = apply_activation(Input, activations)
             result = Input @ W.T
 
             return result
 
     except:
-        print(Fore.RED + "ERROR: Unexpected Output or wrong model parameters from: predict_model_ssd." + Style.RESET_ALL)
+        print(Fore.RED + "ERROR: Unexpected Output or wrong model parameters from: predict_model_storage." + Style.RESET_ALL)
         sys.exit()
 
 
-def reverse_predict_model_ssd(output, model_name, model_path=''):
+def reverse_predict_from_storage(output, model_name, model_path=''):
 
     """
     reverse prediction function from storage
@@ -366,15 +411,15 @@ def reverse_predict_model_ssd(output, model_name, model_path=''):
         Input = W.T @ output
         return Input
     except:
-        print(Fore.RED + "ERROR: Unexpected Output or wrong model parameters from: reverse_predict_model_ssd." + Style.RESET_ALL)
+        print(Fore.RED + "ERROR: Unexpected Output or wrong model parameters from: reverse_predict_model_storage." + Style.RESET_ALL)
         sys.exit()
     
 
 
-def predict_model_ram(Input, W, scaler_params=None, activation_potentiation=['linear'], is_mlp=False):
+def predict_from_memory(Input, W, scaler_params=None, activations=['linear'], is_mlp=False):
 
     """
-    Function to make a prediction using a potentiation learning artificial neural network (PLAN).
+    Function to make a prediction.
     from memory.
 
     Args:
@@ -384,7 +429,7 @@ def predict_model_ram(Input, W, scaler_params=None, activation_potentiation=['li
         
         scaler_params (list): standard scaler params list: mean,std. (optional) Default: None.
         
-        activation_potentiation (list[str]): activation list for deep PLAN or activation list for MLP layers. Default: ['linear']
+        activations (list[str]): activation list for deep PLAN or activation list for MLP layers. Default: ['linear']
         
         is_mlp (bool, optional): Predict from PLAN model or MLP model ? Default: False (PLAN)
     Returns:
@@ -398,32 +443,32 @@ def predict_model_ram(Input, W, scaler_params=None, activation_potentiation=['li
     
         Input = standard_scaler(None, Input, scaler_params)
         
-        if isinstance(activation_potentiation, str):
-            activation_potentiation = [activation_potentiation]
-        elif isinstance(activation_potentiation, list):
-            activation_potentiation = [item if isinstance(item, list) or isinstance(item, str) else [item] for item in activation_potentiation]
+        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(W)):
-                if i != len(W) - 1 and i != 0: layer = apply_activation(layer, activation_potentiation[i])
+                if i != len(W) - 1 and i != 0: layer = apply_activation(layer, activations[i])
                 layer = layer @ W[i].T
             
             return layer
 
         else:
 
-            Input = apply_activation(Input, activation_potentiation)
+            Input = apply_activation(Input, activations)
             result = Input @ W.T
 
             return result
         
     except:
-        print(Fore.RED + "ERROR: Unexpected input or wrong model parameters from: predict_model_ram." + Style.RESET_ALL)
+        print(Fore.RED + "ERROR: Unexpected input or wrong model parameters from: predict_model_memory." + Style.RESET_ALL)
         sys.exit()
 
-def reverse_predict_model_ram(output, W):
+def reverse_predict_from_memory(output, W):
 
     """
     reverse prediction function from memory
@@ -443,7 +488,7 @@ def reverse_predict_model_ram(output, W):
         return Input
     
     except:
-        print(Fore.RED + "ERROR: Unexpected Output or wrong model parameters from: reverse_predict_model_ram." + Style.RESET_ALL)
+        print(Fore.RED + "ERROR: Unexpected Output or wrong model parameters from: reverse_predict_model_memory." + Style.RESET_ALL)
         sys.exit()
 
 
@@ -462,7 +507,7 @@ def get_acc():
     return 2
 
 
-def get_act_pot():
+def get_act():
 
     return 3
 

pyerualjetwork/model_operations_cuda.py

@@ -1,3 +1,45 @@
+""" 
+
+
+Model Operations on CUDA
+========================
+This module hosts functions for handling all operational processes related to models on CUDA GPU, including:
+
+- Saving and loading models
+- Making predictions from memory
+- Making predictions from storage
+- Retrieving model weights
+- Retrieving model activation functions
+- Retrieving model accuracy
+- Running the model in reverse (applicable to PLAN models)
+
+Module functions:
+-----------------
+- save_model()
+- load_model()
+- predict_from_storage()
+- predict_from_memory()
+- reverse_predict_from_storage()
+- reverse_predict_from_memory()
+- get_weights()
+- get_act()
+- get_preds()
+- get_preds_softmax()
+- get_acc()
+- get_scaler()
+- get_model_type()
+
+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 cupy as cp
 import numpy as np
 from colorama import Fore, Style
@@ -15,7 +57,7 @@ def save_model(model_name,
                scaler_params=None,
                test_acc=None,
                model_path='',
-               activation_potentiation=['linear'],
+               activations=['linear'],
                weights_type='npy',
                weights_format='raw',
                show_architecture=None,
@@ -39,7 +81,7 @@ def save_model(model_name,
         
         model_path: (str): Path where the model will be saved. For example: C:/Users/beydili/Desktop/denemePLAN/ default: ''
        
-        activation_potentiation: (list[str]): For deeper PLAN networks, activation function parameters. Or activation function parameters for MLP layers. For more information please run this code: plan.activations_list() default: ['linear']
+        activations: (list[str]): For deeper PLAN networks, activation function parameters. Or activation function parameters for MLP layers. For more information please run this code: plan.activations_list() default: ['linear']
         
         weights_type: (str): Type of weights to save (options: 'txt', 'pkl', 'npy', 'mat'). default: 'npy'
         
@@ -65,12 +107,12 @@ def save_model(model_name,
     if isinstance(W, np.ndarray):
         W = np.copy(W)
         
-    if isinstance(activation_potentiation, str):
-        activation_potentiation = [activation_potentiation]
+    if isinstance(activations, str):
+        activations = [activations]
     else:
-        activation_potentiation = [item if isinstance(item, list) else [item] for item in activation_potentiation]
+        activations = [item if isinstance(item, list) else [item] for item in activations]
 
-    activation = activation_potentiation.copy()
+    activation = activations.copy()
 
     if test_acc is not None:
         test_acc= float(test_acc)
@@ -161,7 +203,7 @@ def save_model(model_name,
             'WEIGHTS FORMAT': weights_format,
             'MODEL PATH': model_path,
             'STANDARD SCALER': scaler_params,
-            'ACTIVATION POTENTIATION': activation
+            'ACTIVATION FUNCTIONS': activation
             }
 
     df = pd.DataFrame(data)
@@ -248,13 +290,17 @@ def load_model(model_name,
 
     except:
 
-        print(Fore.RED + "ERROR: Model Path error. acceptable form: 'C:/Users/hasancanbeydili/Desktop/denemePLAN/' from: load_model" + Style.RESET_ALL)
+        print(Fore.RED + "ERROR: Model Path or Model Name error. acceptable form: 'C:/Users/hasancanbeydili/Desktop/denemePLAN/' from: load_model" + Style.RESET_ALL)
 
         sys.exit()
 
-    activation_potentiation = list(df['ACTIVATION POTENTIATION'])
-    activation_potentiation = [x for x in activation_potentiation if not (isinstance(x, float) and cp.isnan(x))]
-    activation_potentiation = [item for item in activation_potentiation if item != '']
+    try: 
+        activations = list(df['ACTIVATION FUNCTIONS']) # for PyerualJetwork >=5 Versions.
+    except KeyError:
+        activations = list(df['ACTIVATION POTENTIATION']) # for PyerualJetwork <5 Versions.
+
+    activations = [x for x in activations if not (isinstance(x, float) and cp.isnan(x))]
+    activations = [item for item in activations if item != '']
 
     scaler_params_cpu = df['STANDARD SCALER'].tolist()
     
@@ -297,14 +343,14 @@ def load_model(model_name,
         W = W.tolist()
         W = [cp.array(item) for item in W]
 
-    return W, None, None, activation_potentiation, scaler_params, None, model_type
+    return W, None, None, activations, scaler_params, None, model_type
 
 
 
-def predict_model_ssd(Input, model_name, model_path='', dtype=cp.float32):
+def predict_from_storage(Input, model_name, model_path='', dtype=cp.float32):
 
     """
-    Function to make a prediction using a potentiation learning artificial neural network (PLAN).
+    Function to make a prediction
     from storage
 
     Args:
@@ -328,15 +374,15 @@ def predict_model_ssd(Input, model_name, model_path='', dtype=cp.float32):
 
         model = load_model(model_name, model_path)
         
-        activation_potentiation = model[get_act_pot()]
+        activations = model[get_act()]
         scaler_params = model[get_scaler()]
         W = model[get_weights()]
         model_type = model[get_model_type()]
 
-        if isinstance(activation_potentiation, str):
-            activation_potentiation = [activation_potentiation]
-        elif isinstance(activation_potentiation, list):
-            activation_potentiation = [item if isinstance(item, list) or isinstance(item, str) else [item] for item in activation_potentiation]
+        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]
 
         Input = standard_scaler(None, Input, scaler_params)
 
@@ -344,14 +390,14 @@ def predict_model_ssd(Input, model_name, model_path='', dtype=cp.float32):
             
             layer = Input
             for i in range(len(W)):
-                if i != len(W) - 1 and i != 0: layer = apply_activation(layer, activation_potentiation[i])
+                if i != len(W) - 1 and i != 0: layer = apply_activation(layer, activations[i])
                 layer = layer @ W[i].T
             
             return layer
 
         else:
 
-            Input = apply_activation(Input, activation_potentiation)
+            Input = apply_activation(Input, activations)
             result = Input @ W.T
 
             return result
@@ -362,7 +408,7 @@ def predict_model_ssd(Input, model_name, model_path='', dtype=cp.float32):
 
     
 
-def reverse_predict_model_ssd(output, model_name, model_path='', dtype=cp.float32):
+def reverse_predict_from_storage(output, model_name, model_path='', dtype=cp.float32):
 
     """
     reverse prediction function from storage
@@ -394,10 +440,10 @@ def reverse_predict_model_ssd(output, model_name, model_path='', dtype=cp.float3
         sys.exit()
 
 
-def predict_model_ram(Input, W, scaler_params=None, activation_potentiation=['linear'], is_mlp=False):
+def predict_from_memory(Input, W, scaler_params=None, activations=['linear'], is_mlp=False):
 
     """
-    Function to make a prediction using a potentiation learning artificial neural network (PLAN).
+    Function to make a prediction
     from memory.
 
     Args:
@@ -407,7 +453,7 @@ def predict_model_ram(Input, W, scaler_params=None, activation_potentiation=['li
         
         scaler_params (list): standard scaler params list: mean,std. (optional) Default: None.
         
-        activation_potentiation (list[str]): activation list for deep PLAN or activation list for MLP layers. Default: ['linear']
+        activations (list[str]): activation list for deep PLAN or activation list for MLP layers. Default: ['linear']
         
         is_mlp (bool, optional): Predict from PLAN model or MLP model ? Default: False (PLAN)
     Returns:
@@ -419,10 +465,10 @@ def predict_model_ram(Input, W, scaler_params=None, activation_potentiation=['li
 
     try:
         
-        if isinstance(activation_potentiation, str):
-            activation_potentiation = [activation_potentiation]
-        elif isinstance(activation_potentiation, list):
-            activation_potentiation = [item if isinstance(item, list) or isinstance(item, str) else [item] for item in activation_potentiation]
+        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]
             
         Input = standard_scaler(None, Input, scaler_params)
         
@@ -430,14 +476,14 @@ def predict_model_ram(Input, W, scaler_params=None, activation_potentiation=['li
             
             layer = Input
             for i in range(len(W)):
-                if i != len(W) - 1 and i != 0: layer = apply_activation(layer, activation_potentiation[i])
+                if i != len(W) - 1 and i != 0: layer = apply_activation(layer, activations[i])
                 layer = layer @ W[i].T
             
             return layer
 
         else:
 
-            Input = apply_activation(Input, activation_potentiation)
+            Input = apply_activation(Input, activations)
             result = Input @ W.T
 
             return result
@@ -447,7 +493,7 @@ def predict_model_ram(Input, W, scaler_params=None, activation_potentiation=['li
         sys.exit()
 
 
-def reverse_predict_model_ram(output, W, dtype=cp.float32):
+def reverse_predict_from_memory(output, W, dtype=cp.float32):
 
     """
     reverse prediction function from memory
@@ -490,7 +536,7 @@ def get_acc():
     return 2
 
 
-def get_act_pot():
+def get_act():
 
     return 3