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 latent space visualisers #47

Open
WolfByttner opened this issue Jan 24, 2021 · 3 comments
Open

Add latent space visualisers #47

WolfByttner opened this issue Jan 24, 2021 · 3 comments

Comments

@WolfByttner
Copy link
Contributor

No description provided.

@Saran-nns
Copy link
Member

I guess, this is done here

@JustinShenk
Copy link
Collaborator

Thanks for pointing out the relevant code.

Please update the documentation to show intended behavior (preferably with an image since it is a visualizer), add type annotations for latent, and change method to snake case as per PEP8.

Regarding usage: the usage section is not clear, perhaps make it similar to other methods in trajectory.py:

    .. doctest::
    
    >> ... # doctest: +SKIP

This will allow autodocumentation with sphinx. Since we don't want the code to actually run during doctest, add +SKIP.

Also, shall we stick to Google Docstring format (Args, Returns)? Inconsistent docstrings are a code smell.

@Saran-nns
Copy link
Member

Thanks for pointing this out. Recently I made the above-suggested changes as per issue #68 Also, there is a branch for linting and docstrings already. Will work on each module one by one.

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

No branches or pull requests

3 participants