scikit-base


Namescikit-base JSON
Version 0.12.0 PyPI version JSON
download
home_pageNone
SummaryBase classes for sklearn-like parametric objects
upload_time2024-11-13 21:49:13
maintainerFranz Király
docs_urlNone
authorNone
requires_python<3.14,>=3.9
licenseBSD 3-Clause License Copyright (c) 2022, skbase Developers All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
keywords data-science machine-learning scikit-learn
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <a href="https://skbase.readthedocs.io/en/latest/"><img src="https://github.com/sktime/skbase/blob/main/docs/source/images/skbase-logo-with-name.png" width="175" align="right" /></a>

# Welcome to skbase

> A framework factory for scikit-learn-like and sktime-like parametric objects

`skbase` provides base classes for creating scikit-learn-like parametric objects,
along with tools to make it easier to build your own packages that follow these design patterns.

:rocket: Version 0.12.0 is now available. Check out our
[release notes](https://skbase.readthedocs.io/en/latest/changelog.html).

| Overview | |
|---|---|
| **CI/CD** | [![Tests](https://github.com/sktime/skbase/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/sktime/skbase/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/sktime/skbase/branch/main/graph/badge.svg?token=2J424NLO82)](https://codecov.io/gh/sktime/skbase) [![Documentation Status](https://readthedocs.org/projects/skbase/badge/?version=latest)](https://skbase.readthedocs.io/en/latest/?badge=latest) [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/sktime/skbase/main.svg)](https://results.pre-commit.ci/latest/github/sktime/skbase/main) |
| **Code** |  [![!pypi](https://img.shields.io/pypi/v/scikit-base?color=orange)](https://pypi.org/project/scikit-base/)  [![!python-versions](https://img.shields.io/pypi/pyversions/scikit-base)](https://www.python.org/) [![!black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit) |
| **Downloads** | ![PyPI - Downloads](https://img.shields.io/pypi/dw/scikit-base) ![PyPI - Downloads](https://img.shields.io/pypi/dm/scikit-base) [![Downloads](https://static.pepy.tech/personalized-badge/scikit-base?period=total&units=international_system&left_color=grey&right_color=blue&left_text=cumulative%20(pypi))](https://pepy.tech/project/scikit-base) |
| **Citation** | [![DOI](https://zenodo.org/badge/494649836.svg)](https://zenodo.org/doi/10.5281/zenodo.10980557) |

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors)
<!-- ALL-CONTRIBUTORS-BADGE:END -->

## Documentation and Tutorials

To learn more about the package check out:

* our [documentation](https://skbase.readthedocs.io/en/latest/)
* our [introductory tutorial](https://github.com/sktime/sktime-tutorial-pydata-seattle-2023) (jupyter notebooks and video presentation)

## :hourglass_flowing_sand: Install skbase
For trouble shooting or more information, see our
[detailed installation instructions](https://skbase.readthedocs.io/en/latest/user_documentation/installation.html).

- **Operating system**: macOS X · Linux · Windows 8.1 or higher
- **Python version**: Python 3.9, 3.10, 3.11, 3.12, and 3.13
- **Package managers**: [pip]

[pip]: https://pip.pypa.io/en/stable/

### pip
skbase releases are available as source packages and binary wheels via PyPI
and can be installed using pip. Checkout the full list of pre-compiled [wheels on PyPi](https://pypi.org/simple/skbase/).

To install the core package use:

```bash
pip install scikit-base
```

or, if you want to install with the maximum set of dependencies, use:

```bash
pip install scikit-base[all_extras]
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "scikit-base",
    "maintainer": "Franz Kir\u00e1ly",
    "docs_url": null,
    "requires_python": "<3.14,>=3.9",
    "maintainer_email": "sktime developers <sktime.toolbox@gmail.com>",
    "keywords": "data-science, machine-learning, scikit-learn",
    "author": null,
    "author_email": "sktime developers <sktime.toolbox@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/5f/ab/d534a45bd81d0e06fe8c6e9766f86bd63b5b37d1574c3cb415c32d512665/scikit_base-0.12.0.tar.gz",
    "platform": null,
    "description": "<a href=\"https://skbase.readthedocs.io/en/latest/\"><img src=\"https://github.com/sktime/skbase/blob/main/docs/source/images/skbase-logo-with-name.png\" width=\"175\" align=\"right\" /></a>\n\n# Welcome to skbase\n\n> A framework factory for scikit-learn-like and sktime-like parametric objects\n\n`skbase` provides base classes for creating scikit-learn-like parametric objects,\nalong with tools to make it easier to build your own packages that follow these design patterns.\n\n:rocket: Version 0.12.0 is now available. Check out our\n[release notes](https://skbase.readthedocs.io/en/latest/changelog.html).\n\n| Overview | |\n|---|---|\n| **CI/CD** | [![Tests](https://github.com/sktime/skbase/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/sktime/skbase/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/sktime/skbase/branch/main/graph/badge.svg?token=2J424NLO82)](https://codecov.io/gh/sktime/skbase) [![Documentation Status](https://readthedocs.org/projects/skbase/badge/?version=latest)](https://skbase.readthedocs.io/en/latest/?badge=latest) [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/sktime/skbase/main.svg)](https://results.pre-commit.ci/latest/github/sktime/skbase/main) |\n| **Code** |  [![!pypi](https://img.shields.io/pypi/v/scikit-base?color=orange)](https://pypi.org/project/scikit-base/)  [![!python-versions](https://img.shields.io/pypi/pyversions/scikit-base)](https://www.python.org/) [![!black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit) |\n| **Downloads** | ![PyPI - Downloads](https://img.shields.io/pypi/dw/scikit-base) ![PyPI - Downloads](https://img.shields.io/pypi/dm/scikit-base) [![Downloads](https://static.pepy.tech/personalized-badge/scikit-base?period=total&units=international_system&left_color=grey&right_color=blue&left_text=cumulative%20(pypi))](https://pepy.tech/project/scikit-base) |\n| **Citation** | [![DOI](https://zenodo.org/badge/494649836.svg)](https://zenodo.org/doi/10.5281/zenodo.10980557) |\n\n<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->\n[![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors)\n<!-- ALL-CONTRIBUTORS-BADGE:END -->\n\n## Documentation and Tutorials\n\nTo learn more about the package check out:\n\n* our [documentation](https://skbase.readthedocs.io/en/latest/)\n* our [introductory tutorial](https://github.com/sktime/sktime-tutorial-pydata-seattle-2023) (jupyter notebooks and video presentation)\n\n## :hourglass_flowing_sand: Install skbase\nFor trouble shooting or more information, see our\n[detailed installation instructions](https://skbase.readthedocs.io/en/latest/user_documentation/installation.html).\n\n- **Operating system**: macOS X \u00b7 Linux \u00b7 Windows 8.1 or higher\n- **Python version**: Python 3.9, 3.10, 3.11, 3.12, and 3.13\n- **Package managers**: [pip]\n\n[pip]: https://pip.pypa.io/en/stable/\n\n### pip\nskbase releases are available as source packages and binary wheels via PyPI\nand can be installed using pip. Checkout the full list of pre-compiled [wheels on PyPi](https://pypi.org/simple/skbase/).\n\nTo install the core package use:\n\n```bash\npip install scikit-base\n```\n\nor, if you want to install with the maximum set of dependencies, use:\n\n```bash\npip install scikit-base[all_extras]\n```\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause License  Copyright (c) 2022, skbase Developers All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
    "summary": "Base classes for sklearn-like parametric objects",
    "version": "0.12.0",
    "project_urls": {
        "documentation": "https://github.com/sktime/skbase",
        "download": "https://pypi.org/project/skbase/#files",
        "homepage": "https://github.com/sktime/skbase",
        "repository": "https://github.com/sktime/skbase"
    },
    "split_keywords": [
        "data-science",
        " machine-learning",
        " scikit-learn"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "401fc6418e81e8cce8b7f785d74b154741486ece82e098b1a8053682fa7fd882",
                "md5": "5c409e7af7ed41f53094240fcc78a8a4",
                "sha256": "a0679305131ac4753ff6ee72877f831bc68597b7884feede0ab4b32ff520e018"
            },
            "downloads": -1,
            "filename": "scikit_base-0.12.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5c409e7af7ed41f53094240fcc78a8a4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.14,>=3.9",
            "size": 141517,
            "upload_time": "2024-11-13T21:49:11",
            "upload_time_iso_8601": "2024-11-13T21:49:11.206303Z",
            "url": "https://files.pythonhosted.org/packages/40/1f/c6418e81e8cce8b7f785d74b154741486ece82e098b1a8053682fa7fd882/scikit_base-0.12.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5fabd534a45bd81d0e06fe8c6e9766f86bd63b5b37d1574c3cb415c32d512665",
                "md5": "5060c60d88016004e0a6cee9b6a51f4c",
                "sha256": "2f801a149dda944481f327f5b3c6137aa53dc6974d097b086cfbba107034a7fe"
            },
            "downloads": -1,
            "filename": "scikit_base-0.12.0.tar.gz",
            "has_sig": false,
            "md5_digest": "5060c60d88016004e0a6cee9b6a51f4c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.14,>=3.9",
            "size": 118741,
            "upload_time": "2024-11-13T21:49:13",
            "upload_time_iso_8601": "2024-11-13T21:49:13.538665Z",
            "url": "https://files.pythonhosted.org/packages/5f/ab/d534a45bd81d0e06fe8c6e9766f86bd63b5b37d1574c3cb415c32d512665/scikit_base-0.12.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-13 21:49:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "sktime",
    "github_project": "skbase",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "scikit-base"
}
        
Elapsed time: 0.68744s