oikan 0.0.3.1__tar.gz → 0.0.3.2__tar.gz

{oikan-0.0.3.1 → oikan-0.0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oikan
-Version: 0.0.3.1
+Version: 0.0.3.2
 Summary: OIKAN: Neuro-Symbolic ML for Scientific Discovery
 Author: Arman Zhalgasbayev
 License: MIT
@@ -202,7 +202,7 @@ loaded_model.load("outputs/model.json")
 
 ### Architecture Diagram
 
-*Will be updated soon..*
+![OIKAN v0.0.3(1) Architecture](https://raw.githubusercontent.com/silvermete0r/oikan/main/docs/media/oikan-v0.0.3(1)-architecture-oop.png)
 
 ## Contributing
 
@@ -222,7 +222,7 @@ If you use OIKAN in your research, please cite:
 
 ```bibtex
 @software{oikan2025,
-  title = {OIKAN: Optimized Interpretable Kolmogorov-Arnold Networks},
+  title = {OIKAN: Neuro-Symbolic ML for Scientific Discovery},
   author = {Zhalgasbayev, Arman},
   year = {2025},
   url = {https://github.com/silvermete0r/OIKAN}

{oikan-0.0.3.1 → oikan-0.0.3.2}/README.md

@@ -184,7 +184,7 @@ loaded_model.load("outputs/model.json")
 
 ### Architecture Diagram
 
-*Will be updated soon..*
+![OIKAN v0.0.3(1) Architecture](https://raw.githubusercontent.com/silvermete0r/oikan/main/docs/media/oikan-v0.0.3(1)-architecture-oop.png)
 
 ## Contributing
 
@@ -204,7 +204,7 @@ If you use OIKAN in your research, please cite:
 
 ```bibtex
 @software{oikan2025,
-  title = {OIKAN: Optimized Interpretable Kolmogorov-Arnold Networks},
+  title = {OIKAN: Neuro-Symbolic ML for Scientific Discovery},
   author = {Zhalgasbayev, Arman},
   year = {2025},
   url = {https://github.com/silvermete0r/OIKAN}

{oikan-0.0.3.1 → oikan-0.0.3.2}/oikan/model.py

@@ -8,6 +8,9 @@ from abc import ABC, abstractmethod
 import json
 from .neural import TabularNet
 from .utils import evaluate_basis_functions, get_features_involved
+from sklearn.model_selection import train_test_split
+from sklearn.metrics import r2_score, accuracy_score
+import sys
 
 class OIKAN(ABC):
     """
@@ -18,7 +21,7 @@ class OIKAN(ABC):
     hidden_sizes : list, optional (default=[64, 64])
         List of hidden layer sizes for the neural network.
     activation : str, optional (default='relu')
-        Activation function for the neural network ('relu' or 'tanh').
+        Activation function for the neural network ('relu', 'tanh', 'leaky_relu', 'elu', 'swish', 'gelu').
     augmentation_factor : int, optional (default=10)
         Number of augmented samples per original sample.
     polynomial_degree : int, optional (default=2)
@@ -35,10 +38,12 @@ class OIKAN(ABC):
         Batch size for neural network training.
     verbose : bool, optional (default=False)
         Whether to display training progress.
+    evaluate_nn : bool, optional (default=False)
+        Whether to evaluate neural network performance before full training.
     """
     def __init__(self, hidden_sizes=[64, 64], activation='relu', augmentation_factor=10, 
                  polynomial_degree=2, alpha=0.1, sigma=0.1, epochs=100, lr=0.001, batch_size=32, 
-                 verbose=False):
+                 verbose=False, evaluate_nn=False):
         self.hidden_sizes = hidden_sizes
         self.activation = activation
         self.augmentation_factor = augmentation_factor
@@ -49,8 +54,10 @@ class OIKAN(ABC):
         self.lr = lr
         self.batch_size = batch_size
         self.verbose = verbose
+        self.evaluate_nn = evaluate_nn
         self.neural_net = None
         self.symbolic_model = None
+        self.evaluation_done = False
 
     @abstractmethod
     def fit(self, X, y):
@@ -61,7 +68,7 @@ class OIKAN(ABC):
         pass
 
     def get_formula(self):
-        """Returns the symbolic formula(s) as a string or list of strings."""
+        """Returns the symbolic formula(s) as a string (regression) or list of strings (classification)."""
         if self.symbolic_model is None:
             raise ValueError("Model not fitted yet.")
         basis_functions = self.symbolic_model['basis_functions']
@@ -172,10 +179,53 @@ class OIKAN(ABC):
             if 'classes' in model_data:
                 self.classes_ = np.array(model_data['classes'])
 
+    def _evaluate_neural_net(self, X, y, output_size, loss_fn):
+        """Evaluates neural network performance on train-test split."""
+        X_train, X_test, y_train, y_test = train_test_split(X, y, test_size=0.2, random_state=42)
+        
+        input_size = X.shape[1]
+        self.neural_net = TabularNet(input_size, self.hidden_sizes, output_size, self.activation)
+        optimizer = optim.Adam(self.neural_net.parameters(), lr=self.lr)
+        
+        # Train on the training set
+        self._train_neural_net(X_train, y_train, output_size, loss_fn)
+        
+        # Evaluate on test set
+        self.neural_net.eval()
+        with torch.no_grad():
+            y_pred = self.neural_net(torch.tensor(X_test, dtype=torch.float32))
+            if output_size == 1:  # Regression
+                y_pred = y_pred.numpy()
+                score = r2_score(y_test, y_pred)
+                metric_name = "R² Score"
+            else:  # Classification
+                y_pred = torch.argmax(y_pred, dim=1).numpy()
+                y_test = torch.argmax(y_test, dim=1).numpy()
+                score = accuracy_score(y_test, y_pred)
+                metric_name = "Accuracy"
+        
+        print(f"\nNeural Network Evaluation:")
+        print(f"Train size: {len(X_train)}, Test size: {len(X_test)}")
+        print(f"{metric_name}: {score:.4f}")
+        
+        # Ask user for confirmation
+        response = input("\nProceed with full training and symbolic regression? [Y/n]: ").lower()
+        if response not in ['y', 'yes']:
+            sys.exit("Training cancelled by user.")
+
+        # Retrain on full dataset
+        self._train_neural_net(X, y, output_size, loss_fn)
+
     def _train_neural_net(self, X, y, output_size, loss_fn):
         """Trains the neural network on the input data."""
+        if self.evaluate_nn and not self.evaluation_done:
+            self.evaluation_done = True
+            self._evaluate_neural_net(X, y, output_size, loss_fn)
+            return
+            
         input_size = X.shape[1]
-        self.neural_net = TabularNet(input_size, self.hidden_sizes, output_size, self.activation)
+        if self.neural_net is None:
+            self.neural_net = TabularNet(input_size, self.hidden_sizes, output_size, self.activation)
         optimizer = optim.Adam(self.neural_net.parameters(), lr=self.lr)
         dataset = torch.utils.data.TensorDataset(torch.tensor(X, dtype=torch.float32), 
                                                torch.tensor(y, dtype=torch.float32))
@@ -263,10 +313,14 @@ class OIKANRegressor(OIKAN):
         X = np.asarray(X)
         y = np.asarray(y).reshape(-1, 1)
         self._train_neural_net(X, y, output_size=1, loss_fn=nn.MSELoss())
+        if self.verbose:
+            print(f"Original data: features shape: {X.shape} | target shape: {y.shape}")
         X_aug = self._generate_augmented_data(X)
         self.neural_net.eval()
         with torch.no_grad():
             y_aug = self.neural_net(torch.tensor(X_aug, dtype=torch.float32)).detach().numpy()
+        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)
 
     def predict(self, X):
@@ -311,10 +365,14 @@ class OIKANClassifier(OIKAN):
         n_classes = len(self.classes_)
         y_onehot = nn.functional.one_hot(torch.tensor(y_encoded), num_classes=n_classes).float()
         self._train_neural_net(X, y_onehot, output_size=n_classes, loss_fn=nn.CrossEntropyLoss())
+        if self.verbose:
+            print(f"Original data: features shape: {X.shape} | target shape: {y.shape}")
         X_aug = self._generate_augmented_data(X)
         self.neural_net.eval()
         with torch.no_grad():
             logits_aug = self.neural_net(torch.tensor(X_aug, dtype=torch.float32)).detach().numpy()
+        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)
 
     def predict(self, X):

{oikan-0.0.3.1 → oikan-0.0.3.2}/oikan.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oikan
-Version: 0.0.3.1
+Version: 0.0.3.2
 Summary: OIKAN: Neuro-Symbolic ML for Scientific Discovery
 Author: Arman Zhalgasbayev
 License: MIT
@@ -202,7 +202,7 @@ loaded_model.load("outputs/model.json")
 
 ### Architecture Diagram
 
-*Will be updated soon..*
+![OIKAN v0.0.3(1) Architecture](https://raw.githubusercontent.com/silvermete0r/oikan/main/docs/media/oikan-v0.0.3(1)-architecture-oop.png)
 
 ## Contributing
 
@@ -222,7 +222,7 @@ If you use OIKAN in your research, please cite:
 
 ```bibtex
 @software{oikan2025,
-  title = {OIKAN: Optimized Interpretable Kolmogorov-Arnold Networks},
+  title = {OIKAN: Neuro-Symbolic ML for Scientific Discovery},
   author = {Zhalgasbayev, Arman},
   year = {2025},
   url = {https://github.com/silvermete0r/OIKAN}

{oikan-0.0.3.1 → oikan-0.0.3.2}/oikan.egg-info/SOURCES.txt

@@ -6,7 +6,6 @@ oikan/__init__.py
 oikan/exceptions.py
 oikan/model.py
 oikan/neural.py
-oikan/symbolic.py
 oikan/utils.py
 oikan.egg-info/PKG-INFO
 oikan.egg-info/SOURCES.txt

{oikan-0.0.3.1 → oikan-0.0.3.2}/pyproject.toml

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

oikan-0.0.3.1/oikan/symbolic.py

@@ -1,55 +0,0 @@
-import numpy as np
-from sklearn.preprocessing import PolynomialFeatures
-from sklearn.linear_model import Lasso
-
-def symbolic_regression(X, y, degree=2, alpha=0.1):
-    """
-    Performs symbolic regression on the input data.
-    
-    Parameters:
-    -----------
-    X : array-like of shape (n_samples, n_features)
-        Input data.
-    y : array-like of shape (n_samples,) or (n_samples, n_targets)
-        Target values.
-    degree : int, optional (default=2)
-        Maximum polynomial degree.
-    alpha : float, optional (default=0.1)
-        L1 regularization strength.
-    
-    Returns:
-    --------
-    dict : Contains 'basis_functions', 'coefficients' (or 'coefficients_list'), 'n_features', 'degree'
-    """
-    poly = PolynomialFeatures(degree=degree, include_bias=True)
-    X_poly = poly.fit_transform(X)
-    model = Lasso(alpha=alpha, fit_intercept=False)
-    model.fit(X_poly, y)
-    if len(y.shape) == 1 or y.shape[1] == 1:
-        coef = model.coef_.flatten()
-        selected_indices = np.where(np.abs(coef) > 1e-6)[0]
-        return {
-            'n_features': X.shape[1],
-            'degree': degree,
-            'basis_functions': poly.get_feature_names_out()[selected_indices].tolist(),
-            'coefficients': coef[selected_indices].tolist()
-        }
-    else:
-        coefficients_list = []
-        selected_indices = set()
-        for c in range(y.shape[1]):
-            coef = model.coef_[c]
-            indices = np.where(np.abs(coef) > 1e-6)[0]
-            selected_indices.update(indices)
-        selected_indices = list(selected_indices)
-        basis_functions = poly.get_feature_names_out()[selected_indices].tolist()
-        for c in range(y.shape[1]):
-            coef = model.coef_[c]
-            coef_selected = coef[selected_indices].tolist()
-            coefficients_list.append(coef_selected)
-        return {
-            'n_features': X.shape[1],
-            'degree': degree,
-            'basis_functions': basis_functions,
-            'coefficients_list': coefficients_list
-        }