Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BartekPog committed Jun 27, 2020
1 parent 1340351 commit ce0ab72
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
12 changes: 8 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
# modelcreator - Automated Machine Learning Library
# modelcreator - AutoML package

This library contains a **Machine** which is meant to do the **learning** for you.
This package contains a **Machine** which is meant to do the **learning** for you. It can automaticly create a fitting predictive model for given data.

## Instalation

To use the library you have to just run:
To use the package run:

```bash
pip install modelcreator
```

## Usage

The input may be either a path to **csv** file or a **pandas DataFrame** object.

#### CSV path input

The library assumes that the last column of the training dataset contains the expected results. The dataset (both training and predictive) must be provided as a csv file.

If the results column contains text the _Machine_ will do its best to learn to _classify_ the data correctly. In case of a number in it _regression_ will be performed.
Expand Down Expand Up @@ -89,4 +93,4 @@ machine2 = Machine('machine.pkl')

### Development

Have a feature idea or just want to help? Take a look at the issues tab or make a pull request!
Have a feature idea or just want to help? Take a look at the [issues tab](https://github.com/BartekPog/modelcreator/issues)!
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

setuptools.setup(
name="modelcreator",
version="0.9.0",
version="0.9.1",
author="Bartłomiej Pogodziński",
author_email="bartek.pogod@gmail.com",
description="Machine Learning package for quick fast model generation and comparison",
Expand Down

0 comments on commit ce0ab72

Please sign in to comment.