Skip to content
This repository was archived by the owner on Jul 1, 2023. It is now read-only.

Fix documentation errors in convolutional layers #281

Merged
merged 2 commits into from
Jun 24, 2019

Conversation

Shashi456
Copy link
Contributor

Looks like #275 didn't update a few places of the documentation to reflect dilation.

@jon-tow
Copy link
Contributor

jon-tow commented Jun 23, 2019

Hey @Shashi456 isn't it a bit redundant to summarize the layer by listing its initialization parameters?

@Shashi456
Copy link
Contributor Author

@jon-tow I think so too on some level. But what i've discovered is we have documentation consistently for all the extension inits as well. Although i found it somewhat extensive and redundant initially, reading the docs i've discovered that it helps understand different types of initializations for layers.

@eaplatanios
Copy link
Contributor

Personally I would rather not list all parameters in the summary. That's why they're document as arguments of the initializer anyway. Listing them is redundant and also makes the documentation harder to maintain, as also indicated by this PR. :)

@Shashi456
Copy link
Contributor Author

Shashi456 commented Jun 23, 2019

@eaplatanios, I think the current norm as far as layers are concerned is to write description for every function. Since the docs are generated from the files, have all functions including init.

We could look at a format where in we avoid redundancy atleast in the parent layer functions by not describing the init since we already have parameter descriptions.

@Shashi456
Copy link
Contributor Author

The error :

[3/39] Compiling TensorFlow Recurrent.swift
/swift-apis/Sources/TensorFlow/Layers/Recurrent.swift:267:58: error: value of type 'Cell.State' has no member 'withoutDerivative'
        return self(inputs, initialState: cell.zeroState.withoutDerivative())

@Shashi456
Copy link
Contributor Author

Oh I'll have to merge master. Probably. Will do that in a second.

@rxwei
Copy link
Contributor

rxwei commented Jun 24, 2019

Could you please do a pull from master?

@rxwei
Copy link
Contributor

rxwei commented Jun 24, 2019

Yep, you beat me to it :)

@Shashi456
Copy link
Contributor Author

Can this be merged?

@rxwei rxwei merged commit b2e3699 into tensorflow:master Jun 24, 2019
@rxwei rxwei changed the title Fixing Documentation errors Fix documentation errors in convolutional layers Jun 24, 2019
@Shashi456 Shashi456 deleted the doc-update branch August 29, 2019 16:03
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants