oikan 0.0.3.4__tar.gz → 0.0.3.6__tar.gz

{oikan-0.0.3.4 → oikan-0.0.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oikan
-Version: 0.0.3.4
+Version: 0.0.3.6
 Summary: OIKAN: Neuro-Symbolic ML for Scientific Discovery
 Author: Arman Zhalgasbayev
 License: MIT
@@ -35,6 +35,11 @@ OIKAN is a neuro-symbolic machine learning framework inspired by Kolmogorov-Arno
 [![GitHub issues](https://img.shields.io/github/issues/silvermete0r/OIKAN.svg)](https://github.com/silvermete0r/oikan/issues)
 [![Docs](https://img.shields.io/badge/docs-passing-brightgreen)](https://silvermete0r.github.io/oikan/)
 
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/silvermete0r/oikan)
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/silvermete0r/oikan/blob/main/examples/oikan-v0-0-3-get-started-template-notebook.ipynb)
+[![Open In Kaggle](https://kaggle.com/static/images/open-in-kaggle.svg)](https://www.kaggle.com/code/armanzhalgasbayev/oikan-v0-0-3-get-started-template-notebook)
+[![Static Badge](https://img.shields.io/badge/oikan-violet?style=flat&label=awesome)](https://github.com/silvermete0r/awesome-oikan)
+
 > **Important Disclaimer**: OIKAN is an experimental research project. It is not intended for production use or real-world applications. This framework is designed for research purposes, experimentation, and academic exploration of neuro-symbolic machine learning concepts.
 
 ## Key Features
@@ -62,14 +67,15 @@ OIKAN implements a modern interpretation of the Kolmogorov-Arnold Representation
    - Automatic pruning of insignificant terms
    
    ```python
-   class OIKANRegressor:
-       def __init__(self, hidden_sizes=[64, 64], activation='relu',
+    class OIKAN:
+        def __init__(self, hidden_sizes=[64, 64], activation='relu',
                     polynomial_degree=2, alpha=0.1):
-           # Neural network for learning complex patterns
-           self.neural_net = TabularNet(input_size, hidden_sizes, activation)
-           # Symbolic regression for interpretable formulas
-           self.symbolic_model = None
-
+            # Neural network for learning complex patterns
+            self.neural_net = TabularNet(input_size, hidden_sizes, activation)
+            # Data augmentation for better coverage
+            self.augmented_data = self.augment_data(X, y, augmentation_factor=5)
+            # Symbolic regression for interpretable formulas
+            self.symbolic_regression = SymbolicRegression(alpha=alpha)
    ```
 
 3. **Basis Functions**: Core set of interpretable transformations:
@@ -109,9 +115,20 @@ cd OIKAN
 pip install -e .  # Install in development mode
 ```
 
+#### System Requirements
+
+| Requirement       | Details                              |
+|-------------------|--------------------------------------|
+| Python            | Version 3.7 or higher               |
+| Operating System  | Platform independent (Windows/macOS/Linux) |
+| Memory            | Recommended minimum 4GB RAM         |
+| Disk Space        | ~100MB for installation (including dependencies) |
+| GPU               | Optional (for faster training)      |
+| Dependencies      | torch, numpy, scikit-learn, sympy, tqdm   |
+
 ### Regression Example
 ```python
-from oikan.model import OIKANRegressor
+from oikan import OIKANRegressor
 from sklearn.metrics import mean_squared_error
 
 # Initialize model
@@ -126,7 +143,8 @@ model = OIKANRegressor(
     lr=0.001, # Learning rate
     batch_size=32, # Batch size for training
     verbose=True, # Verbose output during training
-    evaluate_nn=True # Validate neural network performance before full process
+    evaluate_nn=True, # Validate neural network performance before full process
+    random_state=42 # Random seed for reproducibility
 )
 
 # Fit the model
@@ -140,7 +158,7 @@ mse = mean_squared_error(y_test, y_pred)
 print("Mean Squared Error:", mse)
 
 # Get symbolic formula
-formula = model.get_formula() # default: type='original' -> returns all formula without pruning | other options: 'sympied' -> simplified formula using sympy; 'latex' -> LaTeX format
+formula = model.get_formula() # default: type='original' -> returns all formula without pruning | other options: 'sympy' -> simplified formula using sympy; 'latex' -> LaTeX format
 print("Symbolic Formula:", formula)
 
 # Get feature importances
@@ -160,7 +178,7 @@ loaded_model.load("outputs/model.json")
 
 ### Classification Example
 ```python
-from oikan.model import OIKANClassifier
+from oikan import OIKANClassifier
 from sklearn.metrics import accuracy_score
 
 # Initialize model
@@ -175,7 +193,8 @@ model = OIKANClassifier(
     lr=0.001, # Learning rate
     batch_size=32, # Batch size for training
     verbose=True, # Verbose output during training
-    evaluate_nn=True # Validate neural network performance before full process
+    evaluate_nn=True, # Validate neural network performance before full process
+    random_state=42 # Random seed for reproducibility
 )
 
 # Fit the model
@@ -189,7 +208,7 @@ accuracy = model.score(X_test, y_test)
 print("Accuracy:", accuracy)
 
 # Get symbolic formulas for each class
-formulas = model.get_formula() # default: type='original' -> returns all formula without pruning | other options: 'sympied' -> simplified formula using sympy; 'latex' -> LaTeX format
+formulas = model.get_formula() # default: type='original' -> returns all formula without pruning | other options: 'sympy' -> simplified formula using sympy; 'latex' -> LaTeX format
 for i, formula in enumerate(formulas):
     print(f"Class {i} Formula:", formula)
    
@@ -209,7 +228,13 @@ loaded_model.load("outputs/model.json")
 
 ### Architecture Diagram
 
-![OIKAN v0.0.3(1) Architecture](https://raw.githubusercontent.com/silvermete0r/oikan/main/docs/media/oikan-v0.0.3(1)-architecture-oop.png)
+#### High-Level Architecture:
+
+![OIKAN v0.0.3 High-Level Architecture](https://raw.githubusercontent.com/silvermete0r/oikan/main/docs/media/oikan_v0.0.3_high_level_architecture.png)
+
+#### UML Diagram:
+
+![OIKAN v0.0.3(2) Architecture](https://raw.githubusercontent.com/silvermete0r/oikan/main/docs/media/oikan-v0.0.3(2)-architecture-oop.png)
 
 ## OIKAN Symbolic Model Compilers
 

{oikan-0.0.3.4 → oikan-0.0.3.6}/README.md

@@ -16,6 +16,11 @@ OIKAN is a neuro-symbolic machine learning framework inspired by Kolmogorov-Arno
 [![GitHub issues](https://img.shields.io/github/issues/silvermete0r/OIKAN.svg)](https://github.com/silvermete0r/oikan/issues)
 [![Docs](https://img.shields.io/badge/docs-passing-brightgreen)](https://silvermete0r.github.io/oikan/)
 
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/silvermete0r/oikan)
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/silvermete0r/oikan/blob/main/examples/oikan-v0-0-3-get-started-template-notebook.ipynb)
+[![Open In Kaggle](https://kaggle.com/static/images/open-in-kaggle.svg)](https://www.kaggle.com/code/armanzhalgasbayev/oikan-v0-0-3-get-started-template-notebook)
+[![Static Badge](https://img.shields.io/badge/oikan-violet?style=flat&label=awesome)](https://github.com/silvermete0r/awesome-oikan)
+
 > **Important Disclaimer**: OIKAN is an experimental research project. It is not intended for production use or real-world applications. This framework is designed for research purposes, experimentation, and academic exploration of neuro-symbolic machine learning concepts.
 
 ## Key Features
@@ -43,14 +48,15 @@ OIKAN implements a modern interpretation of the Kolmogorov-Arnold Representation
    - Automatic pruning of insignificant terms
    
    ```python
-   class OIKANRegressor:
-       def __init__(self, hidden_sizes=[64, 64], activation='relu',
+    class OIKAN:
+        def __init__(self, hidden_sizes=[64, 64], activation='relu',
                     polynomial_degree=2, alpha=0.1):
-           # Neural network for learning complex patterns
-           self.neural_net = TabularNet(input_size, hidden_sizes, activation)
-           # Symbolic regression for interpretable formulas
-           self.symbolic_model = None
-
+            # Neural network for learning complex patterns
+            self.neural_net = TabularNet(input_size, hidden_sizes, activation)
+            # Data augmentation for better coverage
+            self.augmented_data = self.augment_data(X, y, augmentation_factor=5)
+            # Symbolic regression for interpretable formulas
+            self.symbolic_regression = SymbolicRegression(alpha=alpha)
    ```
 
 3. **Basis Functions**: Core set of interpretable transformations:
@@ -90,9 +96,20 @@ cd OIKAN
 pip install -e .  # Install in development mode
 ```
 
+#### System Requirements
+
+| Requirement       | Details                              |
+|-------------------|--------------------------------------|
+| Python            | Version 3.7 or higher               |
+| Operating System  | Platform independent (Windows/macOS/Linux) |
+| Memory            | Recommended minimum 4GB RAM         |
+| Disk Space        | ~100MB for installation (including dependencies) |
+| GPU               | Optional (for faster training)      |
+| Dependencies      | torch, numpy, scikit-learn, sympy, tqdm   |
+
 ### Regression Example
 ```python
-from oikan.model import OIKANRegressor
+from oikan import OIKANRegressor
 from sklearn.metrics import mean_squared_error
 
 # Initialize model
@@ -107,7 +124,8 @@ model = OIKANRegressor(
     lr=0.001, # Learning rate
     batch_size=32, # Batch size for training
     verbose=True, # Verbose output during training
-    evaluate_nn=True # Validate neural network performance before full process
+    evaluate_nn=True, # Validate neural network performance before full process
+    random_state=42 # Random seed for reproducibility
 )
 
 # Fit the model
@@ -121,7 +139,7 @@ mse = mean_squared_error(y_test, y_pred)
 print("Mean Squared Error:", mse)
 
 # Get symbolic formula
-formula = model.get_formula() # default: type='original' -> returns all formula without pruning | other options: 'sympied' -> simplified formula using sympy; 'latex' -> LaTeX format
+formula = model.get_formula() # default: type='original' -> returns all formula without pruning | other options: 'sympy' -> simplified formula using sympy; 'latex' -> LaTeX format
 print("Symbolic Formula:", formula)
 
 # Get feature importances
@@ -141,7 +159,7 @@ loaded_model.load("outputs/model.json")
 
 ### Classification Example
 ```python
-from oikan.model import OIKANClassifier
+from oikan import OIKANClassifier
 from sklearn.metrics import accuracy_score
 
 # Initialize model
@@ -156,7 +174,8 @@ model = OIKANClassifier(
     lr=0.001, # Learning rate
     batch_size=32, # Batch size for training
     verbose=True, # Verbose output during training
-    evaluate_nn=True # Validate neural network performance before full process
+    evaluate_nn=True, # Validate neural network performance before full process
+    random_state=42 # Random seed for reproducibility
 )
 
 # Fit the model
@@ -170,7 +189,7 @@ accuracy = model.score(X_test, y_test)
 print("Accuracy:", accuracy)
 
 # Get symbolic formulas for each class
-formulas = model.get_formula() # default: type='original' -> returns all formula without pruning | other options: 'sympied' -> simplified formula using sympy; 'latex' -> LaTeX format
+formulas = model.get_formula() # default: type='original' -> returns all formula without pruning | other options: 'sympy' -> simplified formula using sympy; 'latex' -> LaTeX format
 for i, formula in enumerate(formulas):
     print(f"Class {i} Formula:", formula)
    
@@ -190,7 +209,13 @@ loaded_model.load("outputs/model.json")
 
 ### Architecture Diagram
 
-![OIKAN v0.0.3(1) Architecture](https://raw.githubusercontent.com/silvermete0r/oikan/main/docs/media/oikan-v0.0.3(1)-architecture-oop.png)
+#### High-Level Architecture:
+
+![OIKAN v0.0.3 High-Level Architecture](https://raw.githubusercontent.com/silvermete0r/oikan/main/docs/media/oikan_v0.0.3_high_level_architecture.png)
+
+#### UML Diagram:
+
+![OIKAN v0.0.3(2) Architecture](https://raw.githubusercontent.com/silvermete0r/oikan/main/docs/media/oikan-v0.0.3(2)-architecture-oop.png)
 
 ## OIKAN Symbolic Model Compilers
 

{oikan-0.0.3.4 → oikan-0.0.3.6}/oikan/model.py

@@ -41,10 +41,12 @@ class OIKAN(ABC):
         Whether to display training progress.
     evaluate_nn : bool, optional (default=False)
         Whether to evaluate neural network performance before full training.
+    random_state: int, optional (default=None)
+        Random seed for reproducibility.
     """
     def __init__(self, hidden_sizes=[64, 64], activation='relu', augmentation_factor=10, 
                  alpha=0.1, sigma=0.1, epochs=100, lr=0.001, batch_size=32, 
-                 verbose=False, evaluate_nn=False, top_k=5):
+                 verbose=False, evaluate_nn=False, top_k=5, random_state=None):
         if not isinstance(hidden_sizes, list) or not all(isinstance(x, int) and x > 0 for x in hidden_sizes):
             raise InvalidParameterError("hidden_sizes must be a list of positive integers")
         if activation not in ['relu', 'tanh', 'leaky_relu', 'elu', 'swish', 'gelu']:
@@ -78,6 +80,11 @@ class OIKAN(ABC):
         self.neural_net = None
         self.symbolic_model = None
         self.evaluation_done = False
+        self.random_state = random_state
+        
+        if self.random_state is not None:
+            torch.manual_seed(self.random_state)
+            np.random.seed(self.random_state)
 
     @abstractmethod
     def fit(self, X, y):
@@ -93,11 +100,11 @@ class OIKAN(ABC):
         
         Parameter:
         --------
-        type : str, optional (default='original') other options: 'sympied', 'latex'
-            'original' returns the original formula with coefficients, 'sympied' returns sympy simplified formula.
+        type : str, optional (default='original') other options: 'sympy', 'latex'
+            'original' returns the original formula with coefficients, 'sympy' returns sympy simplified formula.
         """
-        if type.lower() not in ['original', 'sympied', 'latex']:
-            raise InvalidParameterError("Invalid type. Choose 'original', 'sympied', 'latex'.")
+        if type.lower() not in ['original', 'sympy', 'latex']:
+            raise InvalidParameterError("Invalid type. Choose 'original', 'sympy', 'latex'.")
         if self.symbolic_model is None:
             raise ValueError("Model not fitted yet.")
         basis_functions = self.symbolic_model['basis_functions']
@@ -114,7 +121,7 @@ class OIKAN(ABC):
                                         for i in range(len(coef)) if coef[i] != 0])
                     formulas.append(f"Class {self.classes_[c]}: {formula if formula else '0'}")
                 return formulas
-        elif type.lower() == 'sympied':
+        elif type.lower() == 'sympy':
             if 'coefficients' in self.symbolic_model:
                 formula = sympify_formula(self.symbolic_model['basis_functions'], self.symbolic_model['coefficients'], self.symbolic_model['n_features'])
                 return formula
@@ -448,6 +455,8 @@ class OIKANRegressor(OIKAN):
         if self.verbose:
             print(f"Augmented data: features shape: {X_aug.shape} | target shape: {y_aug.shape}")
         self._perform_symbolic_regression(X_aug, y_aug)
+        if self.verbose:
+            print("OIKANRegressor model training completed successfully!")
 
     def predict(self, X):
         """
@@ -500,6 +509,8 @@ class OIKANClassifier(OIKAN):
         if self.verbose:
             print(f"Augmented data: features shape: {X_aug.shape} | target shape: {logits_aug.shape}")
         self._perform_symbolic_regression(X_aug, logits_aug)
+        if self.verbose:
+            print("OIKANClassifier model training completed successfully!")
 
     def predict(self, X):
         """

{oikan-0.0.3.4 → oikan-0.0.3.6}/oikan/neural.py

@@ -1,4 +1,5 @@
 import torch.nn as nn
+import torch
 
 class TabularNet(nn.Module):
     """

{oikan-0.0.3.4 → oikan-0.0.3.6}/oikan.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oikan
-Version: 0.0.3.4
+Version: 0.0.3.6
 Summary: OIKAN: Neuro-Symbolic ML for Scientific Discovery
 Author: Arman Zhalgasbayev
 License: MIT
@@ -35,6 +35,11 @@ OIKAN is a neuro-symbolic machine learning framework inspired by Kolmogorov-Arno
 [![GitHub issues](https://img.shields.io/github/issues/silvermete0r/OIKAN.svg)](https://github.com/silvermete0r/oikan/issues)
 [![Docs](https://img.shields.io/badge/docs-passing-brightgreen)](https://silvermete0r.github.io/oikan/)
 
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/silvermete0r/oikan)
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/silvermete0r/oikan/blob/main/examples/oikan-v0-0-3-get-started-template-notebook.ipynb)
+[![Open In Kaggle](https://kaggle.com/static/images/open-in-kaggle.svg)](https://www.kaggle.com/code/armanzhalgasbayev/oikan-v0-0-3-get-started-template-notebook)
+[![Static Badge](https://img.shields.io/badge/oikan-violet?style=flat&label=awesome)](https://github.com/silvermete0r/awesome-oikan)
+
 > **Important Disclaimer**: OIKAN is an experimental research project. It is not intended for production use or real-world applications. This framework is designed for research purposes, experimentation, and academic exploration of neuro-symbolic machine learning concepts.
 
 ## Key Features
@@ -62,14 +67,15 @@ OIKAN implements a modern interpretation of the Kolmogorov-Arnold Representation
    - Automatic pruning of insignificant terms
    
    ```python
-   class OIKANRegressor:
-       def __init__(self, hidden_sizes=[64, 64], activation='relu',
+    class OIKAN:
+        def __init__(self, hidden_sizes=[64, 64], activation='relu',
                     polynomial_degree=2, alpha=0.1):
-           # Neural network for learning complex patterns
-           self.neural_net = TabularNet(input_size, hidden_sizes, activation)
-           # Symbolic regression for interpretable formulas
-           self.symbolic_model = None
-
+            # Neural network for learning complex patterns
+            self.neural_net = TabularNet(input_size, hidden_sizes, activation)
+            # Data augmentation for better coverage
+            self.augmented_data = self.augment_data(X, y, augmentation_factor=5)
+            # Symbolic regression for interpretable formulas
+            self.symbolic_regression = SymbolicRegression(alpha=alpha)
    ```
 
 3. **Basis Functions**: Core set of interpretable transformations:
@@ -109,9 +115,20 @@ cd OIKAN
 pip install -e .  # Install in development mode
 ```
 
+#### System Requirements
+
+| Requirement       | Details                              |
+|-------------------|--------------------------------------|
+| Python            | Version 3.7 or higher               |
+| Operating System  | Platform independent (Windows/macOS/Linux) |
+| Memory            | Recommended minimum 4GB RAM         |
+| Disk Space        | ~100MB for installation (including dependencies) |
+| GPU               | Optional (for faster training)      |
+| Dependencies      | torch, numpy, scikit-learn, sympy, tqdm   |
+
 ### Regression Example
 ```python
-from oikan.model import OIKANRegressor
+from oikan import OIKANRegressor
 from sklearn.metrics import mean_squared_error
 
 # Initialize model
@@ -126,7 +143,8 @@ model = OIKANRegressor(
     lr=0.001, # Learning rate
     batch_size=32, # Batch size for training
     verbose=True, # Verbose output during training
-    evaluate_nn=True # Validate neural network performance before full process
+    evaluate_nn=True, # Validate neural network performance before full process
+    random_state=42 # Random seed for reproducibility
 )
 
 # Fit the model
@@ -140,7 +158,7 @@ mse = mean_squared_error(y_test, y_pred)
 print("Mean Squared Error:", mse)
 
 # Get symbolic formula
-formula = model.get_formula() # default: type='original' -> returns all formula without pruning | other options: 'sympied' -> simplified formula using sympy; 'latex' -> LaTeX format
+formula = model.get_formula() # default: type='original' -> returns all formula without pruning | other options: 'sympy' -> simplified formula using sympy; 'latex' -> LaTeX format
 print("Symbolic Formula:", formula)
 
 # Get feature importances
@@ -160,7 +178,7 @@ loaded_model.load("outputs/model.json")
 
 ### Classification Example
 ```python
-from oikan.model import OIKANClassifier
+from oikan import OIKANClassifier
 from sklearn.metrics import accuracy_score
 
 # Initialize model
@@ -175,7 +193,8 @@ model = OIKANClassifier(
     lr=0.001, # Learning rate
     batch_size=32, # Batch size for training
     verbose=True, # Verbose output during training
-    evaluate_nn=True # Validate neural network performance before full process
+    evaluate_nn=True, # Validate neural network performance before full process
+    random_state=42 # Random seed for reproducibility
 )
 
 # Fit the model
@@ -189,7 +208,7 @@ accuracy = model.score(X_test, y_test)
 print("Accuracy:", accuracy)
 
 # Get symbolic formulas for each class
-formulas = model.get_formula() # default: type='original' -> returns all formula without pruning | other options: 'sympied' -> simplified formula using sympy; 'latex' -> LaTeX format
+formulas = model.get_formula() # default: type='original' -> returns all formula without pruning | other options: 'sympy' -> simplified formula using sympy; 'latex' -> LaTeX format
 for i, formula in enumerate(formulas):
     print(f"Class {i} Formula:", formula)
    
@@ -209,7 +228,13 @@ loaded_model.load("outputs/model.json")
 
 ### Architecture Diagram
 
-![OIKAN v0.0.3(1) Architecture](https://raw.githubusercontent.com/silvermete0r/oikan/main/docs/media/oikan-v0.0.3(1)-architecture-oop.png)
+#### High-Level Architecture:
+
+![OIKAN v0.0.3 High-Level Architecture](https://raw.githubusercontent.com/silvermete0r/oikan/main/docs/media/oikan_v0.0.3_high_level_architecture.png)
+
+#### UML Diagram:
+
+![OIKAN v0.0.3(2) Architecture](https://raw.githubusercontent.com/silvermete0r/oikan/main/docs/media/oikan-v0.0.3(2)-architecture-oop.png)
 
 ## OIKAN Symbolic Model Compilers
 

{oikan-0.0.3.4 → oikan-0.0.3.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "oikan"
-version = "0.0.3.4"
+version = "0.0.3.6"
 description = "OIKAN: Neuro-Symbolic ML for Scientific Discovery"
 readme = "README.md"
 authors = [{name = "Arman Zhalgasbayev"}]