Move Defaults to to end of arg docstring and standardise values by SamuelMarks · Pull Request #17748 · keras-team/keras (original) (raw)

I've written a Python compiler that can do a bunch of thing. Relevant to Keras I am turning TensorFlow into SQL tables by way of SQLalchemy:

""" Generated from keras.optimizers.sgd. """

SGD = Table( "SGD", metadata, Column( "learning_rate", Float, comment="A Tensor, floating point value, or a schedule that is a tf.keras.optimizers.schedules.LearningRateSchedule, or a callable that takes no arguments and returns the actual value to use. The learning rate", default=0.001, nullable=False, ), Column( "momentum", String, comment="float hyperparameter >= 0 that accelerates gradient descent in the relevant direction and dampens oscillations.e., vanilla gradient descent", default="0, i", nullable=False, ), Column( "nesterov", Boolean, comment="boolean. Whether to apply Nesterov momentum", default=False, nullable=False, ), Column("clipnorm", default=None, nullable=True), Column("clipvalue", default=None, nullable=True), Column("use_ema", Boolean, default=False, nullable=False), Column("ema_overwrite_frequency", default=None, nullable=True), Column("weight_decay", default=None, nullable=True), Column("global_clipnorm", default=None, nullable=True), Column("ema_momentum", Float, default=0.99, nullable=False), Column("jit_compile", Boolean, default=True, nullable=False), Column("name", String, default="SGD", nullable=False), Column("id", Integer, primary_key=True, server_default=Identity()), )

all = ["SGD"]

So this PR rewrite your docstrings to put the Defaults to at the end and limit it to one value or a boolean condition.

PS: I also noticed inconsistent use of backticks. Did you want them everywhere? - This would disambiguate floats from integers I guess