Metadata-Version: 2.1
Name: framework3
Version: 0.1.1
Summary: A flexible framework for machine learning pipelines
License: AGPL-3.0-or-later
Keywords: machine learning,framework,pipeline,ML,AI,data science
Author: Manuel Couto Pintos
Author-email: manuel.couto.pintos@usc.es
Requires-Python: >=3.11,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: boto3 (==1.35.73)
Requires-Dist: cloudpickle (==3.1.0)
Requires-Dist: fastapi (==0.115.5)
Requires-Dist: gensim (==4.3.3)
Requires-Dist: multimethod (==1.12)
Requires-Dist: nltk (==3.9.1)
Requires-Dist: pandas (==2.2.3)
Requires-Dist: pyspark (==3.5.3)
Requires-Dist: rich (==13.9.4)
Requires-Dist: scikit-learn (==1.5.2)
Requires-Dist: scipy (==1.13.1)
Requires-Dist: torch (==2.5.1)
Requires-Dist: tqdm (==4.67.1)
Requires-Dist: transformers (==4.46.3)
Requires-Dist: typeguard (==4.4.1)
Project-URL: Documentation, https://manucouto1.github.io/framework3/
Project-URL: Homepage, https://github.com/manucouto1/framework3
Project-URL: Repository, https://github.com/manucouto1/framework3.git
Description-Content-Type: text/markdown

# Framework3

Framework3 is an innovative platform designed to simplify and accelerate the development of machine learning models. It provides data scientists and machine learning engineers with a flexible and powerful tool to create, experiment with, and deploy models efficiently and in a structured manner. [https://manucouto1.github.io/framework3](https://manucouto1.github.io/framework3)

## Key Features

- Modular and flexible architecture
- Customizable pipelines for ML workflows
- Extensible plugin system for filters, metrics, and storage
- Support for distributed processing with MapReduce
- Integrated model evaluation and optimization tools

## Installation

To install Framework3, follow these steps:

1. Make sure you have Python 3.7 or higher installed on your system.

2. Clone the repository:
   ```
   git clone https://github.com/manucouto1/framework3.git
   ```

3. Navigate to the project directory:
   ```
   cd framework3
   ```

4. Install the dependencies using pip:
   ```
   pip install -r requirements.txt
   ```

## Basic Usage

Here's a basic example of how to use Framework3:

```python
from framework3.plugins.pipelines import F3Pipeline
from framework3.plugins.filters.classification import KnnFilter
from framework3.plugins.metrics import F1, Precision, Recall

# Create a pipeline
pipeline = F3Pipeline(
    plugins=[KnnFilter()],
    metrics=[F1(), Precision(), Recall()]
)

# Fit the model
pipeline.fit(X_train, y_train)

# Make predictions
predictions = pipeline.predict(X_test)

# Evaluate the model
evaluation = pipeline.evaluate(X_test, y_test, y_pred=predictions)
print(evaluation)
```

## Documentation

For more detailed information on how to use Framework3, check out our complete documentation at:

[https://manucouto1.github.io/framework3](https://manucouto1.github.io/framework3)

## Contributing

Contributions are welcome. Please read our contribution guidelines before submitting pull requests.

## License

This project is licensed under the AGPL-3.0 license. See the `LICENSE` file for more details.

## Contact

If you have any questions or suggestions, don't hesitate to open an issue in this repository or contact the development team.

---

Thank you for your interest in Framework3! We hope this tool will be useful in your machine learning projects.

