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.

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

Add input/outputShape information to all KDocs of layers #211

Open
24 tasks
zaleslaw opened this issue Sep 2, 2021 · 2 comments
Open
24 tasks

Add input/outputShape information to all KDocs of layers #211

zaleslaw opened this issue Sep 2, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@zaleslaw
Copy link
Collaborator

zaleslaw commented Sep 2, 2021

We need to have better documentation for our layers.
A few layers have inputShape/outputShape information in the KDocs, copied from Keras documentation, for example
GlobalAvgPool2D

Please add the same documentation section to all the following layers:

  • ELU
  • LeakyReLU
  • PReLU
  • ReLU
  • Softmax
  • ThresholdedReLU
  • DepthwiseConv2D
  • SeparableConv2D
  • Dense
  • Input
  • BatchNorm
  • AvgPool1D
  • AvgPool2D (should be in one format)
  • AvgPool3D
  • GlobalMaxPool1D
  • GlobalMaxPool2D
  • GlobalMaxPool3D
  • MaxPool1D
  • MaxPool2D
  • MaxPool3D
  • Flatten
  • ZeroPadding1D
  • ZeroPadding2D
  • ZeroPadding3D
@zaleslaw zaleslaw added documentation Improvements or additions to documentation good second issue Good for advanced contributors good first issue Good for newcomers and removed good second issue Good for advanced contributors labels Sep 2, 2021
@zaleslaw zaleslaw added this to the 0.3 milestone Sep 13, 2021
@zaleslaw zaleslaw modified the milestones: 0.3, 0.4 Sep 20, 2021
@zaleslaw zaleslaw modified the milestones: 0.4, 0.5 Feb 21, 2022
@ermolenkodev ermolenkodev removed this from the 0.5 milestone Sep 21, 2022
@dosier
Copy link
Contributor

dosier commented Sep 29, 2022

Hey, I'd like to contribute a bit again. Could do this one.

One question I have, in some cases Keras specifies different shapes depending upon the data_format being channels_first or channels_last. I do see we have this implemented for the ZeroPadding.. layers but not for any others.

From what I understand the default implementation uses the channels_last format.

There are two conventions for shapes of images tensors: the channels-last convention (used by TensorFlow) > and the channels-first convention (used by Theano).

Deep Learning with Python - François Chollet
(https://stackoverflow.com/a/54967450/12089702)

So I guess for now we just omit the part about the data_format and only take the channels_last part?

@dosier
Copy link
Contributor

dosier commented Sep 29, 2022

Also I guess Input and Flatten do not need this documentation?

dosier added a commit to dosier/KotlinDL that referenced this issue Sep 29, 2022
- added emphasis
- removed redundant note comment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants