Metadata-Version: 2.1
Name: fast-token-classifier
Version: 0.2.3
Summary: NLP project to identify and categorize named entities in an input text.
Home-page: https://github.com/chineidu/info-extraction
Author: Chinedu Ezeofor
Author-email: neidue@email.com
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: accelerate >=0.20.1
Requires-Dist: click ==8.1.7
Requires-Dist: datasets ==2.14.4
Requires-Dist: ensure ==1.0.3
Requires-Dist: fastapi ==0.90.0
Requires-Dist: fast-token-classifier <=0.3.0,>=0.1.0
Requires-Dist: fsspec ==2023.9.2
Requires-Dist: httpx ==0.25.1
Requires-Dist: loguru >=0.7.0
Requires-Dist: numpy ==1.24.3
Requires-Dist: pre-commit ==2.21.0
Requires-Dist: pydantic <=1.10.13
Requires-Dist: python-dotenv ==1.0.0
Requires-Dist: rich ==13.6.0
Requires-Dist: ruff ==0.1.4
Requires-Dist: seqeval ==1.2.2
Requires-Dist: scikit-learn ==1.2.1
Requires-Dist: tensorflow ==2.13
Requires-Dist: torch ==2.0.1
Requires-Dist: transformers ==4.32.0
Requires-Dist: typeguard ==2.13.3
Requires-Dist: uvicorn ==0.24.0
Provides-Extra: dev
Requires-Dist: black ==22.10.0 ; extra == 'dev'
Requires-Dist: isort ==5.10.1 ; extra == 'dev'
Requires-Dist: pylint ==2.15.10 ; extra == 'dev'
Requires-Dist: pytest >=7.2.0 ; extra == 'dev'
Requires-Dist: pytest-cov ==4.0.0 ; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest >=7.2.0 ; extra == 'test'
Requires-Dist: pytest-cov ==4.0.0 ; extra == 'test'

# INFO-EXTRACTION

NLP project to identify and categorize named entities in an input text.

## Table of Content

- [INFO-EXTRACTION](#info-extraction)
  - [Table of Content](#table-of-content)
  - [Setup Package](#setup-package)
    - [IMPORTANT STEP](#important-step)
    - [List Available Commands](#list-available-commands)
  - [Build And Publish The Package](#build-and-publish-the-package)
  - [Check HugingFace Cache](#check-hugingface-cache)
  - [Run Tests](#run-tests)
  - [Start API](#start-api)

## Setup Package

### IMPORTANT STEP

- To setup the package locally, run:

```sh
make setup_venv
```

### List Available Commands

- To list all the available commands, run:

```sh
make help
```

## Build And Publish The Package

- Build the package by running:

```sh
# Install packages required for building and publishing
python -m pip install build twine

# Build
python setup.py clean --all    
python setup.py sdist bdist_wheel

# Verify build
twine check dist/*

# Upload package
twine upload dist/* --verbose
```

## Check HugingFace Cache

- Check the locally cached models and dataset by running:

```sh
huggingface-cli scan-cache -v
```

## Run Tests

- For unit and integration tests, run:

```sh
# Integration test
make run_integration_test

# All tests
make run_test
```

## Start API

- To start the API, run:

```sh
make run_api
```
