# torchninja
torchninja is a Python package that provides tools for training PyTorch models. It offers a flexible and easy-to-use training framework with built-in functionality for logging, metrics tracking, and model checkpointing.
## Features
- Simplifies the process of training PyTorch models.
- Flexible and customizable trainer class.
- Automatic logging of training progress and metrics.
- Support for model checkpointing to save and load model states.
- Easy integration with TensorBoard for visualizing training metrics.
- Provides utility functions for common tasks in PyTorch model training.
## Installation
You can install torchninja using pip:
```shell
pip install torchninja
```
torchninja has the following dependencies:
- torch
- torchvision
- tensorboard
- tqdm
- numpy
- matplotlib
Make sure these dependencies are installed in your environment before using torchninja.
## Getting Started
To get started with torchninja, you can refer to the `examples` directory in the project repository. It contains example scripts that demonstrate how to use the torchninja trainer class to train a PyTorch model. You can modify these examples according to your specific use case.
## Documentation
The documentation for torchninja is available on the project's GitHub repository:
- [torchninja GitHub repository](https://github.com/silvaan/torchninja)
The documentation provides detailed information on the usage of the torchninja package, including the trainer class, available functionality, and usage examples.
## Contributing
Contributions to torchninja are welcome! If you find any issues, have suggestions for improvements, or would like to add new features, please open an issue or submit a pull request on the project's GitHub repository.
## License
torchninja is released under the MIT License. See the [LICENSE](LICENSE) file for details.
## Contact
For any questions or inquiries, you can reach out to the project author:
- Author: Silvan Ferreira
- Email: silvanfj@gmail.com
Feel free to contact the author for any assistance or collaboration opportunities related to torchninja.
Raw data
{
"_id": null,
"home_page": "https://github.com/silvaan/torchninja",
"name": "torchninja",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Silvan Ferreira",
"author_email": "silvanfj@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/17/89/9259a54302b80471c0aecca6b1a1885277fa1098ec59f48cf8f6e3209fb4/torchninja-0.1.2.tar.gz",
"platform": null,
"description": "# torchninja\n\ntorchninja is a Python package that provides tools for training PyTorch models. It offers a flexible and easy-to-use training framework with built-in functionality for logging, metrics tracking, and model checkpointing.\n\n## Features\n\n- Simplifies the process of training PyTorch models.\n- Flexible and customizable trainer class.\n- Automatic logging of training progress and metrics.\n- Support for model checkpointing to save and load model states.\n- Easy integration with TensorBoard for visualizing training metrics.\n- Provides utility functions for common tasks in PyTorch model training.\n\n## Installation\n\nYou can install torchninja using pip:\n\n```shell\npip install torchninja\n```\n\ntorchninja has the following dependencies:\n\n- torch\n- torchvision\n- tensorboard\n- tqdm\n- numpy\n- matplotlib\n\nMake sure these dependencies are installed in your environment before using torchninja.\n\n## Getting Started\n\nTo get started with torchninja, you can refer to the `examples` directory in the project repository. It contains example scripts that demonstrate how to use the torchninja trainer class to train a PyTorch model. You can modify these examples according to your specific use case.\n\n## Documentation\n\nThe documentation for torchninja is available on the project's GitHub repository:\n\n- [torchninja GitHub repository](https://github.com/silvaan/torchninja)\n\nThe documentation provides detailed information on the usage of the torchninja package, including the trainer class, available functionality, and usage examples.\n\n## Contributing\n\nContributions to torchninja are welcome! If you find any issues, have suggestions for improvements, or would like to add new features, please open an issue or submit a pull request on the project's GitHub repository.\n\n## License\n\ntorchninja is released under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n## Contact\n\nFor any questions or inquiries, you can reach out to the project author:\n\n- Author: Silvan Ferreira\n- Email: silvanfj@gmail.com\n\nFeel free to contact the author for any assistance or collaboration opportunities related to torchninja.\n",
"bugtrack_url": null,
"license": "",
"summary": "Tools for training PyTorch models",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/silvaan/torchninja"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8095953eb012c28e341c003e2a1a1a997afdc7e4ca7ef8f98ea630e39899032e",
"md5": "0c406d5345185d74743780cfe6ab5618",
"sha256": "348c95b25be6794ad8995f41e5c71b76d42853747e1b94758b251315b26865f1"
},
"downloads": -1,
"filename": "torchninja-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0c406d5345185d74743780cfe6ab5618",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8846,
"upload_time": "2023-05-16T11:48:44",
"upload_time_iso_8601": "2023-05-16T11:48:44.014371Z",
"url": "https://files.pythonhosted.org/packages/80/95/953eb012c28e341c003e2a1a1a997afdc7e4ca7ef8f98ea630e39899032e/torchninja-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "17899259a54302b80471c0aecca6b1a1885277fa1098ec59f48cf8f6e3209fb4",
"md5": "564ab1f97d9248d8f8bdcebc83b6765f",
"sha256": "ff98d0431efb7c592bd1ef8513d67f603daf8456756692afe11a2f86c38ead0a"
},
"downloads": -1,
"filename": "torchninja-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "564ab1f97d9248d8f8bdcebc83b6765f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8380,
"upload_time": "2023-05-16T11:48:47",
"upload_time_iso_8601": "2023-05-16T11:48:47.749628Z",
"url": "https://files.pythonhosted.org/packages/17/89/9259a54302b80471c0aecca6b1a1885277fa1098ec59f48cf8f6e3209fb4/torchninja-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-16 11:48:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "silvaan",
"github_project": "torchninja",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "torchninja"
}
JSON
