Metadata-Version: 2.1
Name: lightly_train
Version: 0.2.4
Summary: Train models with self-supervised learning in a single command
Author: Lightly Team
License: AGPL-3.0
Keywords: machine-learning,computer-vision,deep-learning,self-supervised-learning,contrastive-learning,pytorch,python,pretrained-models,embeddings
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: lightly>=1.5.12
Requires-Dist: omegaconf>=2.3
Requires-Dist: psutil>=5.0
Requires-Dist: pytorch_lightning>=2.1
Requires-Dist: torch>=2.0.0
Requires-Dist: torchvision>=0.15.1
Requires-Dist: tqdm>=4.0.0
Provides-Extra: dev
Requires-Dist: pytest>=8.0.0; extra == "dev"
Requires-Dist: pytest-mock>=3.14.0; extra == "dev"
Requires-Dist: ruff>=0.4.0; extra == "dev"
Requires-Dist: mypy>=1.10.0; extra == "dev"
Requires-Dist: types-tqdm>=4.0.0; extra == "dev"
Requires-Dist: licenseheaders>=0.8.8; extra == "dev"
Provides-Extra: super-gradients
Requires-Dist: super-gradients>=3.7; extra == "super-gradients"
Provides-Extra: tensorboard
Requires-Dist: tensorboard>=2.10.0; extra == "tensorboard"
Provides-Extra: timm
Requires-Dist: timm>=1.0.3; extra == "timm"
Provides-Extra: wandb
Requires-Dist: wandb>=0.12.10; extra == "wandb"

# LightlyTrain

*Train models with self-supervised learning in a single command*


## Why LightlyTrain

LightlyTrain uses self-supervised learning (SSL) to train models on large datasets
without the need for labels. It provides simple Python, Command Line, and Docker
interfaces to train models with popular SSL methods such as SimCLR or DINO. The trained
models are ideal starting points for fine-tuning on downstream tasks such as image 
classification, object detection, and segmentation or for generating image embeddings.
Models trained with LightlyTrain result in improved performance, faster convergence, and
better generalization compared to models trained without SSL. Image embeddings created
with LightlyTrain capture more relevant information than their supervised counterparts
and seamlessly extend to new classes due to the unsupervised nature of SSL.

Lightly is the expert in SSL for computer vision and developed LightlyTrain to simplify
model training for any task and dataset.


## Features

* Train models on any image data without labels
* Train models from popular libraries such as [torchvision](https://github.com/pytorch/vision), [TIMM](https://github.com/huggingface/pytorch-image-models), and [SuperGradients](https://github.com/Deci-AI/super-gradients)
* Train custom models
* No SSL expertise required
* Automatic SSL method selection (soon!)
* Python, Command Line, and Docker support
* Multi-GPU and multi-node (soon!) support
* Export models for fine-tuning or inference
* Generate and export image embeddings
* Monitor training progress with TensorBoard, Weights & Biases, Neptune, etc. (soon!)

## License

LightlyTrain is available under an AGPL-3.0 and a commercial license. Please contact us
at info@lightly.ai for more information.

## Contact

* [**Email**](info@lightly.ai)  
* [**Website**](https://www.lightly.ai/lightlytrain)  
* [**Discord**](https://discord.gg/xvNJW94)
