obliquetree 1.0.3__cp311-cp311-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl

obliquetree-1.0.3.dist-info/METADATA

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: obliquetree
+Version: 1.0.3
+Summary: Traditional and Oblique Decision Tree
+Author-email: Samet Copur <sametcopur@yahoo.com>
+License: MIT License
+Project-URL: Documentation, https://obliquetree.readthedocs.io/en/latest/
+Project-URL: Repository, https://github.com/sametcopur/obliquetree
+Project-URL: Tracker, https://github.com/sametcopur/obliquetree/issues
+Keywords: python,data-science,machine-learning,machine-learning-library,explainable-ai,decision-tree,oblique-tree
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=2.2.1
+Requires-Dist: scipy>=1.15.0
+Dynamic: license-file
+
+# obliquetree
+
+`obliquetree` is an advanced decision tree implementation designed to provide high-performance and interpretable models. It supports both classification and regression tasks, enabling a wide range of applications. By offering traditional and oblique splits, it ensures flexibility and improved generalization with shallow trees. This makes it a powerful alternative to regular decision trees.
+
+
+![Tree Visualization](docs/source/_static/tree_visual.png)
+
+
+----
+
+## Getting Started
+
+`obliquetree` combines advanced capabilities with efficient performance. It supports **oblique splits**, leveraging **L-BFGS optimization** to determine the best linear weights for splits, ensuring both speed and accuracy.
+
+In **traditional mode**, without oblique splits, `obliquetree` outperforms `scikit-learn` in terms of speed and adds support for **categorical variables**, providing a significant advantage over many traditional decision tree implementations.
+
+When the **oblique feature** is enabled, `obliquetree` dynamically selects the optimal split type between oblique and traditional splits. If no weights can be found to reduce impurity, it defaults to an **axis-aligned split**, ensuring robustness and adaptability in various scenarios.
+
+In very large trees (e.g., depth 10 or more), the performance of `obliquetree` may converge closely with **traditional trees**. The true strength of `obliquetree` lies in their ability to perform exceptionally well at **shallower depths**, offering improved generalization with fewer splits. Moreover, thanks to linear projections, `obliquetree` significantly outperform traditional trees when working with datasets that exhibit **linear relationships**.
+
+-----
+## Installation
+To install `obliquetree`, use the following pip command:
+```bash
+pip install obliquetree
+```
+
+Using the `obliquetree` library is simple and intuitive. Here's a more generic example that works for both classification and regression:
+
+
+```python
+from obliquetree import Classifier, Regressor
+
+# Initialize the model (Classifier or Regressor)
+model = Classifier(  # Replace "Classifier" with "Regressor" if performing regression
+    use_oblique=True,       # Enable oblique splits
+    max_depth=2,            # Set the maximum depth of the tree
+    n_pair=2,               # Number of feature pairs for optimization
+    random_state=42,        # Set a random state for reproducibility
+    categories=[0, 10, 32], # Specify which features are categorical
+)
+
+# Train the model on the training dataset
+model.fit(X_train, y_train)
+
+# Predict on the test dataset
+y_pred = model.predict(X_test)
+```
+-----
+
+## Documentation
+For example usage, API details, comparisons with axis-aligned trees, and in-depth insights into the algorithmic foundation, we **strongly recommend** referring to the full [documentation](https://obliquetree.readthedocs.io/en/latest/).
+
+---
+## Key Features
+
+- **Oblique Splits**  
+  Perform oblique splits using linear combinations of features to capture complex patterns in data. Supports both linear and soft decision tree objectives for flexible and accurate modeling.
+
+- **Axis-Aligned Splits**  
+  Offers conventional (axis-aligned) splits, enabling users to leverage standard decision tree behavior for simplicity and interpretability.
+
+- **Feature Constraints**  
+  Limit the number of features used in oblique splits with the `n_pair` parameter, promoting simpler, more interpretable tree structures while retaining predictive power.
+
+- **Seamless Categorical Feature Handling**  
+  Natively supports categorical columns with minimal preprocessing. Only label encoding is required, removing the need for extensive data transformation.
+
+- **Robust Handling of Missing Values**  
+  Automatically assigns `NaN` values to the optimal leaf for axis-aligned splits.
+
+- **Customizable Tree Structures**  
+  The flexible API empowers users to design their own tree architectures easily.
+
+- **Exact Equivalence with `scikit-learn`**  
+  Guarantees results identical to `scikit-learn`'s decision trees when oblique and categorical splitting are disabled.
+
+- **Optimized Performance**  
+  Outperforms `scikit-learn` in terms of speed and efficiency when oblique and categorical splitting are disabled:
+  - Up to **50% faster** for datasets with float columns.
+  - Up to **200% faster** for datasets with integer columns.
+
+  ![Performance Comparison (Float)](docs/source/_static/sklearn_perf/performance_comparison_float.png)
+
+  ![Performance Comparison (Integer)](docs/source/_static/sklearn_perf/performance_comparison_int.png)
+
+
+----
+### Contributing
+Contributions are welcome! If you'd like to improve `obliquetree` or suggest new features, feel free to fork the repository and submit a pull request.
+
+-----
+### License
+`obliquetree` is released under the MIT License. See the LICENSE file for more details.

obliquetree-1.0.3.dist-info/RECORD

@@ -0,0 +1,21 @@
+obliquetree/__init__.py,sha256=VQapTBiRrm5l9oV8X2fu3xlvvGTh1cjQ6Hh3ynpArKU,103
+obliquetree/_pywrap.py,sha256=d6XRinPMBxNUf2UlJQkV4TOe3_zbEcM4q8j8QPcXudg,26332
+obliquetree/utils.py,sha256=mEs3ZspxOKUm1SoS-ms0XjQQ1Ci6Ej4oQA53WEYY7VY,30267
+obliquetree/src/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+obliquetree/src/base.cpp,sha256=zDDiQC4letk-5Cd97w3-wZ45rLOsB0HLGM7mFgWHkXs,1416211
+obliquetree/src/base.cpython-311-x86_64-linux-gnu.so,sha256=s1n1U9KNLbuS5Wzc4y85-CBPkDX6JI_rSZeQBBFD-8w,2333520
+obliquetree/src/ccp.cpp,sha256=DuKlYs_HCYFLzMJnCNb3TmKgv2yZspBj7DzyyS-EiCA,948541
+obliquetree/src/ccp.cpython-311-x86_64-linux-gnu.so,sha256=EZkUm65DovVXL4uagF_iIs7eaP0fBuevY1Z5GVBU1_o,1556984
+obliquetree/src/metric.cpp,sha256=wkaoaKW0Z6A0OkK67BpRRBFI50s9vuXVX56A7uUBKZo,1182973
+obliquetree/src/metric.cpython-311-x86_64-linux-gnu.so,sha256=AnYlgr5av5VM-PsEbe9-0xOl1epzo8cWgsirDoiq4Ng,1809472
+obliquetree/src/oblique.cpp,sha256=TO164GjBrfoxYxlMsUpvtWvVqesA0chncEFCva3qCME,1363790
+obliquetree/src/oblique.cpython-311-x86_64-linux-gnu.so,sha256=M45ZleT2GudjoQrw0JrLWRrQL8ln2FGZHnErhITcsM0,2723456
+obliquetree/src/tree.cpp,sha256=IZEGxbVyl7e8cCnKjuCPVLM9KXTsNyT6yo9MUAwQGc4,1130937
+obliquetree/src/tree.cpython-311-x86_64-linux-gnu.so,sha256=PKE_hod3s9J-KDS3G-hC9Gyn5KPMXgxQfzrRViW8vj0,1704888
+obliquetree/src/utils.cpp,sha256=zw5WE-LxF-Ds2JU904mUq5FhD2HY5vc14RNxTG7GuV8,1235423
+obliquetree/src/utils.cpython-311-x86_64-linux-gnu.so,sha256=ke4X_4MqibayAdU7vNkPWX0i1JJ2YimiTbMK_iNvjhQ,2299928
+obliquetree-1.0.3.dist-info/METADATA,sha256=zo1UGljAQo1gfqG3q4-X1L4A4xIUf6UUAaiRQaDlfL4,5662
+obliquetree-1.0.3.dist-info/WHEEL,sha256=N6PyfvHGx46Sh1ny6KlB0rtGwHkXZAwlLCEEPBiTPn8,152
+obliquetree-1.0.3.dist-info/top_level.txt,sha256=m-5N4-iAS5MsFOdk8y1r2ya_i5rVQBgPayHBA-K26qg,12
+obliquetree-1.0.3.dist-info/RECORD,,
+obliquetree-1.0.3.dist-info/licenses/LICENSE,sha256=lLpW3hLh8QbaRAWXRaZ76c80HoVfUr6739D0S7ecslU,1069

obliquetree-1.0.3.dist-info/WHEEL

@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: false
+Tag: cp311-cp311-manylinux_2_24_x86_64
+Tag: cp311-cp311-manylinux_2_28_x86_64
+

obliquetree-1.0.3.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Samet Çopur
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

obliquetree-1.0.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+obliquetree