Metadata-Version: 2.1
Name: sklearn2excel
Version: 0.0.1
Summary: A Python package to facilitate Scikit-learn decision tree export to Excel.
Author-email: Torbjørn Wikestad <torbjorn.wikestad@gmail.com>
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License
Requires-Dist: XlsxWriter <=3.0, <4
Requires-Dist: scikit-learn >=1.0, <2
Project-URL: Home, https://github.com/tobisan5/sklearn2excel

# sklearn2excel
> Bringing decision trees to Excel

<!--
[![NPM Version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Downloads Stats][npm-downloads]][npm-url]
-->

This project aims at a published Python package with a set of tools to export
machine learning models from Scikit-learn to Excel.

<!-- 
Screenshot: 
![](header.png) 
-->

### Project overview

- helpers module
  - [X] export_decisiontrees_to_file
    - [X] A wrapper function for sklearn.tree.export_to_text ()
    - [X] Detects maximum tree depth and applies this parameter
  - [X] create_xlfile
    - [X] Writes a DecisionTreeTable object to a Excel sheet
    - [X] Write features and an initial value of 1 to another sheet
- core module
  - [X] DecisionTreeTable
    - [X] A class that can be instantiated with a text file
    - [X] Transforms and represent decisions trees in a datastructure
    - [X] Exposed properties to get info about the structure
    - [X] Exposed methods to get tests and results as indexed rows
    - [ ] TODO: Handle classifier-type decision trees

## Installation

```sh
pip install sklearn2excel
```

## Usage example

<!--code block with a few useful and motivating examples. Again you’d lay out exactly what people need to type into 
their shell -->

## Development setup

<!--describe how to install all development dependencies and how to run an automated 
test-suite-->

## Release History
<!--
* 0.2.1
    * CHANGE: Update docs (module code remains unchanged)
* 0.2.0
    * CHANGE: Remove `setDefaultXYZ()`
    * ADD: Add `init()`
* 0.1.1
    * FIX: Crash when calling `baz()` (Thanks @GenerousContributorName!)
* 0.1.0
    * The first proper release
    * CHANGE: Rename `foo()` to `bar()`
-->

- 0.0.1
  - Work in progress


## Meta

Torbjørn Wikestad – [@TWikestad](https://twitter.com/twikestad) – torbjorn.wikestad@gmail.com

Distributed under the MIT license. See ``LICENSE`` for more information.

[https://github.com/tobisan5/github-link](https://github.com/tobisan5/)


## Contributing

1. Fork it (<https://github.com/tobisan5/sklearn2excel/fork>)
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new Pull Request

<!-- Markdown link & img dfn's -->
[image]: https://img.shields.io/npm/v/datadog-metrics.svg?style=flat-square
[wiki]: https://github.com/yourname/yourproject/wiki

