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

Engine docs #1141

Merged
merged 8 commits into from
Mar 28, 2021
Merged

Engine docs #1141

merged 8 commits into from
Mar 28, 2021

Conversation

Scitator
Copy link
Member

@Scitator Scitator commented Mar 28, 2021 •
edited by ditwoo
Loading

Before submitting (checklist)

  • Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
  • Did you read the contribution guide?
  • Did you check the code style? catalyst-make-codestyle && catalyst-check-codestyle (pip install -U catalyst-codestyle).
  • Did you make sure to update the docs? We use Google format for all the methods and classes.
  • Did you check the docs with make check-docs?
  • Did you write any new necessary tests?
  • Did you check that your code passes the unit tests pytest . ?
  • Did you add your new functionality to the docs?
  • Did you update the CHANGELOG?

Description

Related Issue

Type of Change

  • Examples / docs / tutorials / contributors update
  • Bug fix (non-breaking change which fixes an issue)
  • Improvement (non-breaking change which improves an existing feature)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

PS

  • I know, that I could join slack for pull request discussion.

@pep8speaks
Copy link

pep8speaks commented Mar 28, 2021 •
edited
Loading

Hello @Scitator! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2021-03-28 17:21:25 UTC

github-actions[bot]
github-actions bot reviewed Mar 28, 2021
View reviewed changes
catalyst/core/engine.py Show resolved Hide resolved
catalyst/core/engine.py Show resolved Hide resolved
catalyst/core/engine.py Show resolved Hide resolved
catalyst/core/engine.py Show resolved Hide resolved
catalyst/core/engine.py Show resolved Hide resolved
catalyst/engines/torch.py Outdated Show resolved Hide resolved
catalyst/engines/torch.py Outdated Show resolved Hide resolved
catalyst/engines/torch.py Outdated Show resolved Hide resolved
catalyst/engines/torch.py Outdated Show resolved Hide resolved
catalyst/engines/torch.py Outdated Show resolved Hide resolved
github-actions[bot]
github-actions bot reviewed Mar 28, 2021
View reviewed changes
catalyst/engines/apex.py Outdated Show resolved Hide resolved
catalyst/engines/apex.py Outdated Show resolved Hide resolved
catalyst/engines/apex.py Outdated Show resolved Hide resolved
catalyst/engines/apex.py Outdated Show resolved Hide resolved
catalyst/engines/amp.py Outdated Show resolved Hide resolved
catalyst/engines/amp.py Outdated Show resolved Hide resolved
catalyst/engines/torch.py Outdated Show resolved Hide resolved
catalyst/engines/torch.py Outdated Show resolved Hide resolved
catalyst/engines/torch.py Outdated Show resolved Hide resolved
catalyst/engines/torch.py Outdated Show resolved Hide resolved
github-actions[bot]
github-actions bot reviewed Mar 28, 2021
View reviewed changes
catalyst/core/engine.py Show resolved Hide resolved
catalyst/core/engine.py Show resolved Hide resolved
catalyst/core/engine.py Show resolved Hide resolved
catalyst/engines/torch.py Outdated Show resolved Hide resolved
@Scitator Scitator merged commit 4723d36 into master Mar 28, 2021
@mergify mergify bot deleted the engine-docs branch March 28, 2021 17:35
zkid18 pushed a commit to zkid18/catalyst that referenced this pull request Apr 4, 2021
@Scitator @ditwoo @zkid18
Engine docs (catalyst-team#1141)
b40d166 
* typings & few docs

* typing fix; disabled `dist.barrier()` in optimizer step for ddp

* docs

* docs: fixed long lines with docs

* docs fixes

* optimizer args

* removed empty line

Co-authored-by: Dmytro Doroshenko <dimdoroshenko@gmail.com>
Scitator added a commit that referenced this pull request Apr 9, 2021
@zkid18 @denyhoof
@Atharva-Phatak @Scitator @bagxi @elephantmipt @ditwoo @ssktotoro
Fix hitrate (#1159)
9e381c8 
* add movielens

* First hitrate metric version

* metrge with upstream

* fix topk_map

* fix error in map

* tests for map

* top_k ndcg

* edit changelog

* edit the tabs

* check codestyle

* check the intent

* check the intent

* remove trailing whitespace

* fixed hitrate

* fixed the docs

* hitrate

* Additive margin softmax (#1131)

* Added Additive-margin softmax

* update changelog.md

* Readme update2 (#1142)

* readme

* batch overfit fix for reproducibility

* batch overfit fix for reproducibility

* readme

* readme update

* extra Config/Hydra API fixes

* codestyle

* updated dl_cpu(workflows)- For passing CI-Tests (#1135)

* updated dl_cpu

* Updated-requirements-ml.txt

* corrected the mistake

* Update dl_cpu.yml

* Update requirements-ml.txt

* Kept dl_cpu 20.04-3.6 minimal as requested

* Corrected the mistakes

* Add requirements parameter

* Update dl_cpu.yml

* Update dl_cpu.yml

Co-authored-by: Sergey Kolesnikov <scitator@gmail.com>

* fix: `_key_value` for schedulers in case of multiple optimizers fixed (#1146)

* Github CI fixes (#1143)

* verbose

* Utils callbacks (#1127)

* quantization.py

* onnx and quantization

* tracing.py

* docs

* fix

* fix

* quantization test

* fix test

* fix comments

* fix comments

* Update catalyst/callbacks/__init__.py

Co-authored-by: Sergey Kolesnikov <scitator@gmail.com>

* tests

* tests

* tests

* tests

* tests

* pycharm tricks

* extra tests

* Utils callbacks (#1145)

* quantization.py

* onnx and quantization

* tracing.py

* docs

* fix

* fix

* quantization test

* fix test

* fix comments

* fix comments

* quantization example

* examples

* CHANGELOG.md

* fix

* fix

* Apply suggestions from code review

Co-authored-by: Sergey Kolesnikov <scitator@gmail.com>

* extra tests 2

* extra tests 2

* extra tests 2

* extra tests 2

* extra tests 2

* extra tests 2

* extra tests 2

* extra tests 2

Co-authored-by: Nikita Balagansky <37884009+elephantmipt@users.noreply.github.com>

* Engine docs (#1141)

* typings & few docs

* typing fix; disabled `dist.barrier()` in optimizer step for ddp

* docs

* docs: fixed long lines with docs

* docs fixes

* optimizer args

* removed empty line

Co-authored-by: Dmytro Doroshenko <dimdoroshenko@gmail.com>

* v21.03.1

* v21.03: minimal version fix (#1147)

* minimal version fix

* docs

* fix: nested dicts in loaders_params/samplers_params overriding (#1150)

* docs (#1152)

* Github CI fix (#1148)

* fix

* fix

* Niftireader (#1151)

* changes for NiftiReader

* adding import statement that was needed and fixing codestyle

* updated CHANGELOG

* removing unnecesary documentation

* fixing codestyle

* updated docs and requirements

* adding a space

* not importing nibabel for docs

* fixing typo

* adding step for contrib pip caching

* fixed codestyle and added a test for reader that uncovered a mistake :)

* hopefully fixing imports

* adding sergey suggested fix

* fixing deploy_push.yml

* updating workflows

Co-authored-by: Kevin Wang <kevin.wang@affectiva.com>
Co-authored-by: Kevin Wang <kcwang26@gsu.edu>

* add changelog

* solved runtime error

* hitrate calculation

Co-authored-by: Daniel Chepenko <dchepenk@yahoo-corp.co>
Co-authored-by: denyhoof <kde97@yandex.ru>
Co-authored-by: Даниил <zkid18@MacBook-Pro.Dlink>
Co-authored-by: Atharva Phatak <athp456@gmail.com>
Co-authored-by: Sergey Kolesnikov <scitator@gmail.com>
Co-authored-by: Yauheni Kachan <19803638+bagxi@users.noreply.github.com>
Co-authored-by: Nikita Balagansky <37884009+elephantmipt@users.noreply.github.com>
Co-authored-by: Dmytro Doroshenko <dimdoroshenko@gmail.com>
Co-authored-by: Kevin Wang <kcwang@ymail.com>
Co-authored-by: Kevin Wang <kevin.wang@affectiva.com>
Co-authored-by: Kevin Wang <kcwang26@gsu.edu>
zkid18 pushed a commit to zkid18/catalyst that referenced this pull request Jul 4, 2021
@Scitator @ditwoo @zkid18
Engine docs (catalyst-team#1141)
5389208 
* typings & few docs

* typing fix; disabled `dist.barrier()` in optimizer step for ddp

* docs

* docs: fixed long lines with docs

* docs fixes

* optimizer args

* removed empty line

Co-authored-by: Dmytro Doroshenko <dimdoroshenko@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@bagxi bagxi Awaiting requested review from bagxi bagxi is a code owner

@ditwoo ditwoo Awaiting requested review from ditwoo

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Scitator @pep8speaks @ditwoo