Metadata-Version: 2.4
Name: torchfoundry
Version: 0.1.7
Summary: Beginner-friendly utilities for building and training PyTorch models.
Author: Lorik Bajrami
License-Expression: MIT
Keywords: pytorch,machine-learning,deep-learning,training,data-science
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: torch
Requires-Dist: torchinfo
Requires-Dist: numpy
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: build; extra == "dev"
Dynamic: license-file

# ⚒️ TorchFoundry

[![Quality Checks](https://github.com/lorik440/TorchFoundry/actions/workflows/test.yml/badge.svg)](https://github.com/lorik440/TorchFoundry/actions/workflows/test.yml)
[![PyPI version](https://img.shields.io/pypi/v/torchfoundry)](https://pypi.org/project/torchfoundry/)
[![Python versions](https://img.shields.io/pypi/pyversions/torchfoundry)](https://pypi.org/project/torchfoundry/)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)

**find your PyTorch workflow.**

TorchFoundry is a Python library designed to simplify and improve everyday workflows when working with PyTorch.
It aims to provide reusable utilities that reduce repetitive code and make machine learning development more convenient.

Make PyTorch development simpler, more reusable, and easier to maintain.
It is available on
[pypi](https://pypi.org/project/torchfoundry/)

### Installation

```bash
pip install torchfoundry
```

### 🎓 Built for Learning
TorchFoundry was created with beginners in mind.

Especially those who want to get into the flow of training machine learning models without being overwhelmed by the complexity that can come with getting started.
The goal is to make the first steps into model development more approachable, allowing learners to focus on understanding the workflow and gradually build confidence in working with PyTorch.

However, simplification comes with trade-offs. 
Abstracting away complexity can introduce limitations and hide implementation details that are important to understand. TorchFoundry is intended as a starting point, not a replacement for learning the underlying concepts. Anyone serious about exploring machine learning should investigate these limitations, understand what happens behind the abstractions, and learn when a more hands-on approach is necessary.

### 🛠️ Built With

* Python
* PyTorch

### 🚧 Project Status

TorchFoundry is currently under development. Features, functionality, and APIs are subject to change.
See the [todo](todo.md) for a list of planned features and improvements.

### 📚 Project and Community Resources

#### GitHub Templates

- [Bug report](.github/ISSUE_TEMPLATE/bug_report.md) — Report a problem and provide details to help reproduce it.
- [Feature request](.github/ISSUE_TEMPLATE/feature_request.md) — Suggest an improvement or new capability for TorchFoundry.
- [General question](.github/ISSUE_TEMPLATE/question.yml) — Ask a question that does not fit a bug report or feature request.
- [Pull request template](.github/ISSUE_TEMPLATE/pull_request_template.md) — Summarize your changes, testing, and contribution checklist when opening a pull request.

#### Guides and Policies

- [Contributing guidelines](CONTRIBUTING.md) — Learn how to get started and contribute changes.
- [Code of Conduct](CODE_OF_CONDUCT.md) — Read the community standards for respectful participation.
- [Security policy](SECURITY.md) — Find supported-version information and how to report a security vulnerability.
- [Accessibility guidelines](ACCESSIBILITY.md) — Review TorchFoundry's accessibility goals, expectations, and known limitations.

### Notice: TorchFoundry is a personal project and is not affiliated with or endorsed by the PyTorch organization.

### 📄 License

[MIT License](LICENSE)

## Enjoy exploring TorchFoundry!
