generated from sehoffmann/python-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
574e904
commit 6354afd
Showing
1 changed file
with
14 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,20 @@ | ||
# dmlcloud | ||
[![](https://img.shields.io/pypi/v/dmlcloud)](https://pypi.org/project/dmlcloud/) | ||
[![](https://img.shields.io/github/actions/workflow/status/sehoffmann/dmlcloud/run_tests.yml?logo=github)](https://github.com/sehoffmann/dmlcloud/actions/workflows/run_tests.yml) | ||
[![](https://img.shields.io/github/actions/workflow/status/sehoffmann/dmlcloud/run_tests.yml?label=tests&logo=github)](https://github.com/sehoffmann/dmlcloud/actions/workflows/run_tests.yml) | ||
[![](https://img.shields.io/github/actions/workflow/status/sehoffmann/dmlcloud/run_linting.yml?label=lint&logo=github)](https://github.com/sehoffmann/dmlcloud/actions/workflows/run_linting.yml) | ||
|
||
Flexibel, easy-to-use, opinionated | ||
*Flexibel, easy-to-use, opinionated* | ||
|
||
**dmlcloud** is a library for distributed training of deep learning models with torch. Its main aim is to do all these tiny little tedious things that everybody just copy pastes over and over again, while still giving you full control over the training loop and maximum flexibility. | ||
*dmlcloud* is a library for **distributed training** of deep learning models with *torch*. Unlike other similar frameworks, dmcloud adds as little additional complexity and abstraction as possible. It is tailored towards a carefully selected set of libraries and workflows. | ||
|
||
Unlike other similar frameworks, such as *lightning*, dmcloud tries to add as little additional complexity and abstraction as possible. Instead, it is tailored towards a careful selected set of libraries and workflows and sticks with them. | ||
## Installation | ||
``` | ||
pip install dmlcloud | ||
``` | ||
|
||
## Why dmlcloud? | ||
- Easy initialization of `torch.distributed` (supports *slurm* and *MPI*). | ||
- Simple, yet powerful, API. No unnecessary abstractions and complications. | ||
- Checkpointing and metric tracking (distributed) | ||
- Extensive logging and diagnostics out-of-the-box. Greatly improve reproducability and traceability. | ||
- A wealth of useful utility functions required for distributed training (e.g. for data set sharding) |