scikit-res


Namescikit-res JSON
Version 0.1.1 PyPI version JSON
download
home_page
SummaryVery Basic package to store results of ML models
upload_time2024-01-25 15:53:39
maintainer
docs_urlNone
authorAlexandreGazagnes
requires_python==3.10.12
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![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/Sulstice/global-chem)  [![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/skres/actions/workflows/ci.yaml/badge.svg)

# Scikit-res : Scikit-learn + results

## About

### Context

Very Basic package to store results of ML models
Grid search results are hard to exploit. This package aims to store them in a more convenient way.


## Installation

### Clone the repository

Please clone the repository using the following command :

* for https :
```bash
git clone https://github.com/AlexandreGazagnes/skres.git
```
* for ssh :
```bash
git clone git@github.com:AlexandreGazagnes/skres.git
```

### Install the dependencies

The project uses [Poetry](https://python-poetry.org/) to manage its dependencies. Please install it using the following command :

```bash
pip install poetry
```

Then, please install the dependencies using the following command :

```bash
poetry install
```

Alternatively, you can install the dependencies using the following command :

```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
pip install -r .utils/requirements-dev.txt
```

## Usage

```python
from skres import SkRes
grid_search = GridSearchCV(...)
grid_search.fit(X_train, y_train)
skres = SkRes(grid_search)
```

## Contributing

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


## License

[GPLv3](LICENSE)
            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "scikit-res",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "==3.10.12",
    "maintainer_email": "",
    "keywords": "",
    "author": "AlexandreGazagnes",
    "author_email": "alex@gazagnes.net",
    "download_url": "https://files.pythonhosted.org/packages/d6/0a/c2c0c70f5655198c309248d7429de7e55128a87df3c2db663224927b6613/scikit_res-0.1.1.tar.gz",
    "platform": null,
    "description": "![image](./.assets/img.png)\n\n[![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/Sulstice/global-chem)  [![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/skres/actions/workflows/ci.yaml/badge.svg)\n\n# Scikit-res : Scikit-learn + results\n\n## About\n\n### Context\n\nVery Basic package to store results of ML models\nGrid search results are hard to exploit. This package aims to store them in a more convenient way.\n\n\n## Installation\n\n### Clone the repository\n\nPlease clone the repository using the following command :\n\n* for https :\n```bash\ngit clone https://github.com/AlexandreGazagnes/skres.git\n```\n* for ssh :\n```bash\ngit clone git@github.com:AlexandreGazagnes/skres.git\n```\n\n### Install the dependencies\n\nThe project uses [Poetry](https://python-poetry.org/) to manage its dependencies. Please install it using the following command :\n\n```bash\npip install poetry\n```\n\nThen, please install the dependencies using the following command :\n\n```bash\npoetry install\n```\n\nAlternatively, you can install the dependencies using the following command :\n\n```bash\npython3 -m venv .venv\nsource .venv/bin/activate\npip install -r requirements.txt\npip install -r .utils/requirements-dev.txt\n```\n\n## Usage\n\n```python\nfrom skres import SkRes\ngrid_search = GridSearchCV(...)\ngrid_search.fit(X_train, y_train)\nskres = SkRes(grid_search)\n```\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\n\n## License\n\n[GPLv3](LICENSE)",
    "bugtrack_url": null,
    "license": "",
    "summary": "Very Basic package to store results of ML models",
    "version": "0.1.1",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7061f1e1597a26a7b3a18534d7f9cbdd52acf46a6fd9cb74bacd07ada85a1326",
                "md5": "7819fc5ae92111a7fe730f5f9f94d85e",
                "sha256": "f1fa3fec182c0bfe5d77ec73a54140047b71be32e64ccc94bbdd48f8633b949e"
            },
            "downloads": -1,
            "filename": "scikit_res-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7819fc5ae92111a7fe730f5f9f94d85e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "==3.10.12",
            "size": 15139,
            "upload_time": "2024-01-25T15:53:38",
            "upload_time_iso_8601": "2024-01-25T15:53:38.795604Z",
            "url": "https://files.pythonhosted.org/packages/70/61/f1e1597a26a7b3a18534d7f9cbdd52acf46a6fd9cb74bacd07ada85a1326/scikit_res-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d60ac2c0c70f5655198c309248d7429de7e55128a87df3c2db663224927b6613",
                "md5": "e38c26f93f06abdd53ad895b2e527ab7",
                "sha256": "f7398243079d39ff0a7fb55379ab99030c91949a123d04bf39bede9f5f4afa5b"
            },
            "downloads": -1,
            "filename": "scikit_res-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "e38c26f93f06abdd53ad895b2e527ab7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "==3.10.12",
            "size": 15092,
            "upload_time": "2024-01-25T15:53:39",
            "upload_time_iso_8601": "2024-01-25T15:53:39.927818Z",
            "url": "https://files.pythonhosted.org/packages/d6/0a/c2c0c70f5655198c309248d7429de7e55128a87df3c2db663224927b6613/scikit_res-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-25 15:53:39",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "scikit-res"
}
        
Elapsed time: 0.16146s