Metadata-Version: 2.1
Name: scikit-transformers
Version: 0.2.0
Summary: Very Basic package make some usefull log transformation for scikit-learn
Author: AlexandreGazagnes
Author-email: alex@gazagnes.net
Requires-Python: ==3.10.12
Classifier: Programming Language :: Python :: 3
Requires-Dist: pandas (>=1.4.0)
Requires-Dist: scikit-learn (>=1.0.0)
Description-Content-Type: text/markdown

![image](./.assets/img.png)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
![Python](https://img.shields.io/badge/python-3.10.x-green.svg)
![Repo Size](https://img.shields.io/github/repo-size/AlexandreGazagnes/scikit-transformers)
[![PEP8](https://img.shields.io/badge/code%20style-pep8-orange.svg)](https://www.python.org/dev/peps/pep-0008/)
[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
![Coverage](.assets/cov.svg)
![CI](https://github.com/AlexandreGazagnes/scikit-transformers/actions/workflows/ci.yaml/badge.svg)
![statics](https://github.com/AlexandreGazagnes/scikit-transformers/actions/workflows/statics.yaml/badge.svg)
![GitHub commit activity](https://img.shields.io/github/commit-activity/m/AlexandreGazagnes/scikit-transformers)

# Scikit-transformers : Scikit-learn + Transformers

## About

Basic package to enable usefull transformers in scikit-learn pipelines.

First transformer implemented is a LogTransformer, which is a simple wrapper around the numpy log function.

## Installation

Using regular pip and venv tools :

```bash
python3 -m venv .venv
source .venv/bin/activate
pip install scikit-transformers

```

## Usage

For a very basic usage :

```python
import pandas as pd

from sktransf import LogTransformer

df = pd.DataFrame(
    { "a": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10],
      "b": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
    }
)

    logger = LogTransformer()
    logger.fit_transform(df)
    df_transf = logger.transform(df)
```

## Documentation

For generic use case, please refer to this [notebook](docs/simple_example.ipynb).

<!-- For more specific use case, please refer to this [notebook](docs/detailed_example.ipynb). -->

<!-- For more detailed information, please refer to the [documentation](https://alexandregazagnes.github.io/scikit-transformers/). -->

A complete documentation will be soon available [here](https://alexandregazagnes.github.io/scikit-transformers/).


## Contributing

Pull requests are welcome.

For major changes, please open an issue first to discuss what you would like to change.

For more information, please refer to the [contributing](CONTRIBUTING.md) file.

## License

[GPLv3](LICENSE)

