# yikit

<!-- badges -->
[![CI](https://github.com/yu9824/yikit/actions/workflows/CI.yml/badge.svg)](https://github.com/yu9824/yikit/actions/workflows/CI.yml)
[![docs](https://github.com/yu9824/yikit/actions/workflows/docs.yml/badge.svg)](https://github.com/yu9824/yikit/actions/workflows/docs.yml)
[![release-pypi](https://github.com/yu9824/yikit/actions/workflows/release-pypi.yml/badge.svg)](https://github.com/yu9824/yikit/actions/workflows/release-pypi.yml)

[![python_badge](https://img.shields.io/pypi/pyversions/yikit)](https://pypi.org/project/yikit/)
[![license_badge](https://img.shields.io/pypi/l/yikit)](https://pypi.org/project/yikit/)
[![PyPI version](https://badge.fury.io/py/yikit.svg)](https://pypi.org/project/yikit/)
[![Downloads](https://static.pepy.tech/badge/yikit)](https://pepy.tech/project/yikit)

<!--
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/yikit.svg)](https://anaconda.org/conda-forge/yikit)
[![Conda Platforms](https://img.shields.io/conda/pn/conda-forge/yikit.svg)](https://anaconda.org/conda-forge/yikit)
-->

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://github.com/python/mypy)
<!-- /badges -->

This is my own toolkit.

## Links

- **Homepage**: [https://github.com/yu9824/yikit](https://github.com/yu9824/yikit)
- **Documentation**: [https://yu9824.github.io/yikit/](https://yu9824.github.io/yikit/)
- **PyPI**: [https://pypi.org/project/yikit/](https://pypi.org/project/yikit/)
- **Issues**: [https://github.com/yu9824/yikit/issues](https://github.com/yu9824/yikit/issues)
- **Releases**: [https://github.com/yu9824/yikit/releases](https://github.com/yu9824/yikit/releases)

## Installation

```bash
pip install yikit
```

### Optional Dependencies

To use specific features, install the following optional dependencies:

```bash
# Optuna (hyperparameter optimization)
pip install yikit[optional]

# Documentation generation
pip install yikit[docs]

# Development environment
pip install yikit[dev]
```

## Documentation

For detailed documentation, please visit [https://yu9824.github.io/yikit/](https://yu9824.github.io/yikit/).

## License

Copyright © 2021 yu9824

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
