Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: self-supervised learning README.md update #1335

Merged
merged 1 commit into from
Oct 25, 2021
Merged

docs: self-supervised learning README.md update #1335

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions examples/self_supervised/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# Self-Supervised Learning Examples
## Requriments

To run examples you need catalyst[cv]==21.09 and catalyst[ml]==21.09
```
pip install catalyst[cv]==21.09
pip install catalyst[ml]==21.09
```

## Description

All traing files have common command line parametrs:
Expand All @@ -18,8 +26,21 @@ Barlow-twins (barlow_twins.py) has an extra parametr ``--offdig_lambda`` - lambd

## Usage

Implemented algorithms:
- Barlow-Twins: ``barlow_twins.py``
- BYOL: ``byol.py``
- SimClR: ``simCLR.py``
- Supervised contrastive: ``supervised_contrastive.py``

You can run an algorithm with a command:
```
python3 barlow_twins.py --batch_size 32
```
Also, you can use the Docker:
```
docker build . -t train-self-supervised
docker run train-self-supervised python3 simCLR.py --batch_size 32
```