Skip to content

Conversation

hanlint
Copy link
Contributor

@hanlint hanlint commented Mar 3, 2022

Fixes: #607 .

  • All algorithms that have default arguments are not annotated as, for example:
alpha (float, optional): <description>. Default: 0.1
  • Opportunistically cleans up some missing docstrings and type annotations here and there.

@hanlint hanlint requested review from growlix and dblalock March 3, 2022 20:28
Copy link
Contributor

@dblalock dblalock left a comment

Choose a reason for hiding this comment

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

Went thru the diff + all the pages under under composer.algorithms in the generated API reference and changes all LGTM, other than extra backticks in augmix.

I also noticed that public functions/modules in blurpool_layers, factorize_modules, factorize_core, and some stochastic_depth files didn't get "Default: whatever" strings, but maybe that was intentional limitation of this PR's scope.

Copy link
Contributor

@growlix growlix left a comment

Choose a reason for hiding this comment

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

Need to change one instance of RandAugment_image to randaugment_image (see comment) but otherwise lgtm!

@hanlint hanlint merged commit e87693b into dev Mar 4, 2022
@hanlint hanlint deleted the hanlin/defaults branch March 4, 2022 01:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add default: to the API docstrings in algorithms module
3 participants