Docs/update 20 12 #1018

Scitator · 2020-12-03T06:40:17Z

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.

pep8speaks · 2020-12-04T07:10:07Z

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-12-09 06:43:20 UTC

github-actions · 2020-12-04T07:20:45Z

catalyst/callbacks/metrics/dice.py

+#     """
+#     Global Multi-Class Dice Metric Callback: calculates the exact
+#     dice score across multiple batches. This callback is good for getting
+#     the dice score with small batch sizes where the batchwise dice is noisier.


[pep8] _{reported by reviewdog 🐶}
E501 line too long (80 > 79 characters)

github-actions · 2020-12-04T07:20:45Z

catalyst/callbacks/metrics/dice.py

+#     """
+#     Global Multi-Class Dice Metric Callback: calculates the exact
+#     dice score across multiple batches. This callback is good for getting
+#     the dice score with small batch sizes where the batchwise dice is noisier.


[pep8] _{reported by reviewdog 🐶}
W505 doc line too long (80 > 79 characters)

github-actions · 2020-12-04T07:20:45Z

catalyst/callbacks/metrics/dice.py

+#             ):
+#                 continue
+#             postfix = (
+#                 self.class_names[i] if self.class_names is not None else str(i)


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

github-actions · 2020-12-04T07:20:46Z

catalyst/callbacks/metrics/dice.py

+#             ):
+#                 continue
+#             postfix = (
+#                 self.class_names[i] if self.class_names is not None else str(i)


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

github-actions · 2020-12-04T07:52:31Z

catalyst/metrics/dice.py

-):
-    """Computes the dice metric.
+) -> float:
+    """Computes the dice score.


[pep8] _{reported by reviewdog 🐶}
D202 No blank lines allowed after function docstring

mergify · 2020-12-04T17:14:34Z

This pull request is now in conflicts. @Scitator, could you fix it? 🙏

github-actions · 2020-12-07T06:46:16Z

catalyst/metrics/dice.py

-from catalyst.utils.torch import get_activation_fn
-
-
+# @TODO: make it work in "per class" mode
 def dice(


[pep8] _{reported by reviewdog 🐶}
E302 expected 2 blank lines, found 1

github-actions · 2020-12-07T06:46:16Z

catalyst/metrics/dice.py

-):
-    """Computes the dice metric.
+) -> float:
+    """Computes the dice score.


[pep8] _{reported by reviewdog 🐶}
D202 No blank lines allowed after function docstring

github-actions · 2020-12-07T07:09:25Z

catalyst/metrics/functional.py

@@ -386,6 +388,19 @@ def check_consistent_length(*tensors):
        raise ValueError("Inconsistent numbers of samples")


+def wrap_fn_output_with_activation(


[pep8] _{reported by reviewdog 🐶}
D103 Missing docstring in public function

github-actions · 2020-12-08T05:49:04Z

catalyst/metrics/functional.py

@@ -386,6 +388,21 @@ def check_consistent_length(*tensors):
        raise ValueError("Inconsistent numbers of samples")


+def wrap_metric_fn_with_activation(


[pep8] _{reported by reviewdog 🐶}
D103 Missing docstring in public function

github-actions · 2020-12-09T06:05:37Z

catalyst/callbacks/metrics/auc.py

@@ -3,21 +3,22 @@
 from catalyst.callbacks.metric import LoaderMetricCallback
 from catalyst.metrics.auc import auc
 from catalyst.metrics.functional import wrap_class_metric2dict


[pep8] _{reported by reviewdog 🐶}
I001 isort found an import in the wrong position

github-actions · 2020-12-09T06:05:37Z

catalyst/callbacks/metrics/auc.py

@@ -3,21 +3,22 @@
 from catalyst.callbacks.metric import LoaderMetricCallback
 from catalyst.metrics.auc import auc
 from catalyst.metrics.functional import wrap_class_metric2dict
+from catalyst.metrics.functional import wrap_metric_fn_with_activation


[pep8] _{reported by reviewdog 🐶}
I001 isort found an import in the wrong position

github-actions · 2020-12-09T06:42:13Z

catalyst/callbacks/metrics/perplexity.py

@@ -29,29 +38,16 @@ def __init__(
        self.cross_entropy_loss = nn.CrossEntropyLoss(
            ignore_index=self.ignore_index
        )
+        metric_fn = partial(_perplexity_metric, criterion=self.cross_entropy_loss)


[pep8] _{reported by reviewdog 🐶}
E501 line too long (82 > 79 characters)

Scitator added 2 commits December 3, 2020 09:39

+

3fb992c

+

90292d5

Scitator requested review from bagxi and ditwoo as code owners December 3, 2020 06:40

Scitator added 7 commits December 3, 2020 10:02

+

8eda597

+

296d1bb

+

12e16d6

+

2237f2f

+

2fecbd7

+

216671c

+

6cf2420

github-actions bot reviewed Dec 4, 2020

View reviewed changes

+

01433be

github-actions bot reviewed Dec 4, 2020

View reviewed changes

Scitator added 4 commits December 6, 2020 11:27

+

9daa5b1

+

b7405f1

+

3d38a0e

+

241ab86

github-actions bot reviewed Dec 7, 2020

View reviewed changes

+

2ecc1b4

github-actions bot reviewed Dec 7, 2020

View reviewed changes

Scitator added 3 commits December 7, 2020 10:13

+

cafdb7c

+

c8030db

+

4cb9d7d

github-actions bot reviewed Dec 8, 2020

View reviewed changes

Scitator added 3 commits December 8, 2020 08:58

+

f5ae4cf

+

6a135a4

+

c00c75d

Scitator added 4 commits December 9, 2020 08:17

+

ca082b3

+

f91ce34

+

024597e

+

e609882

github-actions bot reviewed Dec 9, 2020

View reviewed changes

+

34a5dd4

github-actions bot reviewed Dec 9, 2020

View reviewed changes

+

860a92f

Scitator merged commit b061b78 into master Dec 9, 2020

mergify bot deleted the docs/update-20-12 branch December 9, 2020 06:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs/update 20 12 #1018

Docs/update 20 12 #1018

Scitator commented Dec 3, 2020

pep8speaks commented Dec 4, 2020 •

edited

github-actions bot Dec 4, 2020

github-actions bot Dec 4, 2020

github-actions bot Dec 4, 2020

github-actions bot Dec 4, 2020

github-actions bot Dec 4, 2020

mergify bot commented Dec 4, 2020

github-actions bot Dec 7, 2020

github-actions bot Dec 7, 2020

github-actions bot Dec 7, 2020

github-actions bot Dec 8, 2020

github-actions bot Dec 9, 2020

github-actions bot Dec 9, 2020

github-actions bot Dec 9, 2020

		@@ -386,6 +388,19 @@ def check_consistent_length(*tensors):
		raise ValueError("Inconsistent numbers of samples")


		def wrap_fn_output_with_activation(

		@@ -386,6 +388,21 @@ def check_consistent_length(*tensors):
		raise ValueError("Inconsistent numbers of samples")


		def wrap_metric_fn_with_activation(

Docs/update 20 12 #1018

Docs/update 20 12 #1018

Conversation

Scitator commented Dec 3, 2020

Before submitting

Description

Related Issue

Type of Change

PR review

pep8speaks commented Dec 4, 2020 • edited

Comment last updated at 2020-12-09 06:43:20 UTC

github-actions bot Dec 4, 2020

Choose a reason for hiding this comment

github-actions bot Dec 4, 2020

Choose a reason for hiding this comment

github-actions bot Dec 4, 2020

Choose a reason for hiding this comment

github-actions bot Dec 4, 2020

Choose a reason for hiding this comment

github-actions bot Dec 4, 2020

Choose a reason for hiding this comment

mergify bot commented Dec 4, 2020

github-actions bot Dec 7, 2020

Choose a reason for hiding this comment

github-actions bot Dec 7, 2020

Choose a reason for hiding this comment

github-actions bot Dec 7, 2020

Choose a reason for hiding this comment

github-actions bot Dec 8, 2020

Choose a reason for hiding this comment

github-actions bot Dec 9, 2020

Choose a reason for hiding this comment

github-actions bot Dec 9, 2020

Choose a reason for hiding this comment

github-actions bot Dec 9, 2020

Choose a reason for hiding this comment

pep8speaks commented Dec 4, 2020 •

edited