Metadata-Version: 2.1
Name: kilroy-module-huggingface
Version: 0.7.1
Summary: kilroy module using Hugging Face models 🤗
Home-page: https://github.com/kilroybot/kilroy-module-huggingface
Author: kilroy
Author-email: kilroymail@pm.me
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: kilroy-module-pytorch-py-sdk (>=0.8,<0.9)
Requires-Dist: omegaconf (>=2.2,<3.0)
Requires-Dist: platformdirs (>=2.5,<3.0)
Requires-Dist: pydantic[dotenv] (>=1.10,<2.0)
Requires-Dist: transformers (>=4.21,<5.0)
Requires-Dist: typer[all] (>=0.6,<0.7)
Project-URL: Documentation, https://kilroybot.github.io/kilroy-module-huggingface
Project-URL: Repository, https://github.com/kilroybot/kilroy-module-huggingface
Description-Content-Type: text/markdown

<h1 align="center">kilroy-module-huggingface</h1>

<div align="center">

kilroy module using Hugging Face models 🤗

[![Lint](https://github.com/kilroybot/kilroy-module-huggingface/actions/workflows/lint.yaml/badge.svg)](https://github.com/kilroybot/kilroy-module-huggingface/actions/workflows/lint.yaml)
[![Multiplatform tests](https://github.com/kilroybot/kilroy-module-huggingface/actions/workflows/test-multiplatform.yaml/badge.svg)](https://github.com/kilroybot/kilroy-module-huggingface/actions/workflows/test-multiplatform.yaml)
[![Docker tests](https://github.com/kilroybot/kilroy-module-huggingface/actions/workflows/test-docker.yaml/badge.svg)](https://github.com/kilroybot/kilroy-module-huggingface/actions/workflows/test-docker.yaml)
[![Docs](https://github.com/kilroybot/kilroy-module-huggingface/actions/workflows/docs.yaml/badge.svg)](https://github.com/kilroybot/kilroy-module-huggingface/actions/workflows/docs.yaml)

</div>

---

## Installing

Using `pip`:

```sh
pip install kilroy-module-huggingface
```

## Usage

To run the module server, install the package and run the following command:

```sh
kilroy-module-huggingface
```

This will start the face server on port 11000 by default.
Then you can communicate with the server, for example by using
[this package](https://github.com/kilroybot/kilroy-module-client-py-sdk).

