Metadata-Version: 2.1
Name: fknni
Version: 1.1.1
Summary: Fast implementations of KNN imputation.
Author: Lukas Heumos
Maintainer-email: Lukas Heumos <lukas.heumos@posteo.net>
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: scikit-learn
Requires-Dist: faiss-cpu
Requires-Dist: pandas
Requires-Dist: pre-commit ; extra == "dev"
Requires-Dist: twine>=4.0.2 ; extra == "dev"
Requires-Dist: docutils>=0.8,!=0.18.*,!=0.19.* ; extra == "doc"
Requires-Dist: sphinx>=4 ; extra == "doc"
Requires-Dist: sphinx-book-theme>=1.0.0 ; extra == "doc"
Requires-Dist: myst-nb ; extra == "doc"
Requires-Dist: sphinxcontrib-bibtex>=1.0.0 ; extra == "doc"
Requires-Dist: sphinx-autodoc-typehints ; extra == "doc"
Requires-Dist: sphinxext-opengraph ; extra == "doc"
Requires-Dist: ipykernel ; extra == "doc"
Requires-Dist: ipython ; extra == "doc"
Requires-Dist: sphinx-copybutton ; extra == "doc"
Requires-Dist: matplotlib ; extra == "doc"
Requires-Dist: pytest ; extra == "test"
Requires-Dist: coverage ; extra == "test"
Project-URL: Documentation, https://fknni.readthedocs.io/
Project-URL: Home-page, https://github.com/zethson/fknni
Project-URL: Source, https://github.com/zethson/fknni
Provides-Extra: dev
Provides-Extra: doc
Provides-Extra: test

# fknni

[![Tests][badge-tests]][link-tests]
[![Documentation][badge-docs]][link-docs]

[badge-tests]: https://img.shields.io/github/actions/workflow/status/zethson/fknni/test.yaml?branch=main
[link-tests]: https://github.com/zethson/fknni/actions/workflows/test.yml
[badge-docs]: https://img.shields.io/readthedocs/fknni

Fast implementations of KNN imputation using faiss.
Might support more backends such as annoy and GPUs in the future.
Help is more than welcome!

![image](https://github.com/Zethson/fknni/assets/21954664/216cb745-e0c3-481b-9cae-59bc9a77cdfe)

## Getting started

Please refer to the [documentation][link-docs]. In particular, the

-   [API documentation][link-api].
-   [Faiss example notebook][link-faiss-example].

## Installation

You need to have Python 3.10 or newer installed on your system.
If you don't have Python installed, we recommend installing [Mambaforge](https://github.com/conda-forge/miniforge#mambaforge).

Install the latest release of `fknni` from [PyPI](https://pypi.org/project/fknni):

```bash
pip install fknni
```

Install the latest development version:

```bash
pip install git+https://github.com/zethson/fknni.git@main
```

## Release notes

See the [changelog][changelog].

## Contact

If you found a bug, please use the [issue tracker][issue-tracker].

[issue-tracker]: https://github.com/zethson/fknni/issues
[changelog]: https://fknni.readthedocs.io/latest/changelog.html
[link-docs]: https://fknni.readthedocs.io
[link-api]: https://fknni.readthedocs.io/latest/api.html
[link-faiss-example]: https://fknni.readthedocs.io/en/latest/notebooks/faiss.html

