Docs/modelling layers - Githubissues

keras-team / keras-nlp

Modular Natural Language Processing workflows with Keras

Apache License 2.0

758 stars 227 forks source link

Docs/modelling layers #1502

Closed mykolaskrynnyk closed 5 months ago

mykolaskrynnyk commented 6 months ago

Improves the documentation in layers/modeling by

Adding a missing argument description to TokenAndPositionEmbedding.
Aligning the usage of name argument in TransformerDecoder and TransformerEncoder layers with that in FNetEncoder layer as well as their own docstrings.

mattdangerw commented 5 months ago

@mykolaskrynnyk should I wait for the kwargs doc update or just pull in tie_weights docs for now and we do that on separate PR?

mykolaskrynnyk commented 5 months ago

@mattdangerw , I've just pushed the changes that we discussed earlier. For ReversibleEmbedding, I referenced keras.layers.Embedding in the docstring as that is the class it inherits from directly.

I think we can make similar changes to preprocessing layers. However, I can see that RandomSwap and RandomDeletion expect a specific dtype by default, so we might need to change the wording slightly. At any rate, that will be a different pull request. Cheers.

mattdangerw commented 5 months ago

Thanks very much for the contribution!