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

[wip] FAQ #988

Merged
merged 6 commits into from Nov 9, 2020
Merged

[wip] FAQ #988

merged 6 commits into from Nov 9, 2020

Conversation

Scitator
Copy link
Member

@Scitator Scitator commented Nov 6, 2020

Before submitting

  • 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.

bagxi
bagxi reviewed Nov 8, 2020
View reviewed changes
docs/core/experiment.rst Outdated

Experiment - an abstraction that contains information about the experiment
- a model, a criterion, an optimizer, a scheduler, and their hyperparameters.
It also has information about the data and transformations used.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

has information -> holds information
transformations used -> transformations to apply

docs/core/experiment.rst
==============================================================================

Experiment - an abstraction that contains information about the experiment
- a model, a criterion, an optimizer, a scheduler, and their hyperparameters.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a model -> model / models
a criterion -> criterion / criterions
...

@pep8speaks
Copy link

pep8speaks commented Nov 9, 2020 •
edited

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 2020-11-09 06:58:23 UTC

github-actions[bot]
github-actions bot reviewed Nov 9, 2020
View reviewed changes
catalyst/callbacks/early_stop.py Outdated
logdir="./logdir",
num_epochs=8,
verbose=True,
callbacks=[dl.CheckRunCallback(num_batch_steps=3, num_epoch_steps=3)]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[pep8] reported by reviewdog 🐶
E501 line too long (81 > 79 characters)

catalyst/callbacks/early_stop.py Outdated
logdir="./logdir",
num_epochs=8,
verbose=True,
callbacks=[dl.CheckRunCallback(num_batch_steps=3, num_epoch_steps=3)]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[pep8] reported by reviewdog 🐶
W505 doc line too long (81 > 79 characters)

catalyst/callbacks/early_stop.py Outdated
logdir="./logdir",
num_epochs=8,
verbose=True,
callbacks=[dl.EarlyStoppingCallback(patience=2, metric="loss", minimize=True)]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[pep8] reported by reviewdog 🐶
E501 line too long (90 > 79 characters)

catalyst/callbacks/early_stop.py Outdated
logdir="./logdir",
num_epochs=8,
verbose=True,
callbacks=[dl.EarlyStoppingCallback(patience=2, metric="loss", minimize=True)]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[pep8] reported by reviewdog 🐶
W505 doc line too long (90 > 79 characters)

@Scitator Scitator merged commit dfd21c5 into master Nov 9, 2020
@mergify mergify bot deleted the docs/faq branch November 9, 2020 06:59
github-actions[bot]
github-actions bot reviewed Nov 9, 2020
View reviewed changes
catalyst/callbacks/early_stop.py Outdated
logdir="./logdir",
num_epochs=8,
verbose=True,
callbacks=[dl.CheckRunCallback(num_batch_steps=3, num_epoch_steps=3)]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[pep8] reported by reviewdog 🐶
E501 line too long (81 > 79 characters)

catalyst/callbacks/early_stop.py Outdated
logdir="./logdir",
num_epochs=8,
verbose=True,
callbacks=[dl.CheckRunCallback(num_batch_steps=3, num_epoch_steps=3)]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[pep8] reported by reviewdog 🐶
W505 doc line too long (81 > 79 characters)

catalyst/callbacks/early_stop.py Outdated
logdir="./logdir",
num_epochs=8,
verbose=True,
callbacks=[dl.EarlyStoppingCallback(patience=2, metric="loss", minimize=True)]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[pep8] reported by reviewdog 🐶
E501 line too long (90 > 79 characters)

catalyst/callbacks/early_stop.py Outdated
logdir="./logdir",
num_epochs=8,
verbose=True,
callbacks=[dl.EarlyStoppingCallback(patience=2, metric="loss", minimize=True)]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[pep8] reported by reviewdog 🐶
W505 doc line too long (90 > 79 characters)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bagxi bagxi bagxi left review comments

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

@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.

None yet
3 participants
@Scitator @pep8speaks @bagxi