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

Correct docstring contradicting class signature #2469

Merged

Conversation

mdvthu
Copy link
Contributor

@mdvthu mdvthu commented Jul 13, 2024

Default parameters contradicted docstring

What does this PR do?

  • This PR fixes a typo or improves the docs

Current behaviour:

ipython3
import keras_cv
keras_cv.models.StableDiffusionV2?

Init signature:
keras_cv.models.StableDiffusionV2(
    img_height=512,
    img_width=512,
    jit_compile=True,
)
Docstring:     
Keras implementation of Stable Diffusion v2.
...
    jit_compile: bool, whether to compile the underlying models to XLA.
        This can lead to a significant speedup on some systems. Defaults to
        False.

The current function signature contradicts the docstring. This has been fixed with this PR.

Default parameters contradicted docstring
@divyashreepathihalli divyashreepathihalli merged commit 7131e7f into keras-team:master Aug 20, 2024
6 checks passed
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.

2 participants