Metadata-Version: 2.3
Name: foai_model
Version: 1.0.0
Summary: 
Author: Dariusz Homa
Author-email: dariuszhoma7@gmail.com
Requires-Python: >=3.12,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: accelerate (>=1.6.0,<2.0.0)
Requires-Dist: argparse (>=1.4.0,<2.0.0)
Requires-Dist: bs4 (>=0.0.2,<0.0.3)
Requires-Dist: datasets (>=3.5.0,<4.0.0)
Requires-Dist: dotenv (>=0.9.9,<0.10.0)
Requires-Dist: hf-xet (>=1.0.0,<2.0.0)
Requires-Dist: huggingface-hub (>=0.30.1,<0.31.0)
Requires-Dist: matplotlib (>=3.10.1,<4.0.0)
Requires-Dist: nltk (>=3.9.1,<4.0.0)
Requires-Dist: numpy (>=2.2.4,<3.0.0)
Requires-Dist: pandas (>=2.2.3,<3.0.0)
Requires-Dist: scikit-learn (>=1.6.1,<2.0.0)
Requires-Dist: torch
Requires-Dist: torchvision
Requires-Dist: transformers (>=4.51.0,<5.0.0)
Requires-Dist: wordcloud (>=1.9.4,<2.0.0)
Description-Content-Type: text/markdown

# Fundamentals of AI - Model

[![Pipeline status](https://github.com/Dar3cz3Q-University/FoAI-Model/actions/workflows/ci.yml/badge.svg)](https://github.com/Dar3cz3Q-University/FoAI-Model/tree/master)
[![Version](https://img.shields.io/endpoint?url=https%3A%2F%2Fdar3cz3q-university.github.io%2FFoAI-Model%2Fversion.json
)](https://github.com/Dar3cz3Q-University/FoAI-Model/tree/master)  
[![PyPI version](https://img.shields.io/pypi/v/foai_model)](https://pypi.org/project/foai_model/)
[![Python version](https://img.shields.io/pypi/pyversions/foai_model)](https://pypi.org/project/foai_model/)

---

## Installation

1. Clone repository
    ``` shell
    git clone git@github.com:Dar3cz3Q-University/FoAI-Model.git
    ```
2. Install dependencies
    ``` shell
    poetry install
    ```
3. Manually install CUDA support
    ``` shell
    poetry run pip install torch==2.5.1+cu121 torchvision==0.20.1+cu121 --index-url https://download.pytorch.org/whl/cu121
    ```
4. Train model
    ``` shell
    poetry run train
    ```

## Report

[View the report](https://dar3cz3q-university.github.io/FoAI-Model/)

## Related repositories

* [FoAI-Frontend](https://github.com/Dar3cz3Q-University/FoAI-Frontend)  
* [FoAI-Backend](https://github.com/Dar3cz3Q-University/FoAI-Backend)

