search

traja-team / traja

Python tools for spatial trajectory and time-series data analysis
https://traja.readthedocs.io
MIT License
98 stars 25 forks source link

Add latent space visualisers #47

Open WolfByttner opened 3 years ago

Saran-nns commented 3 years ago

I guess, this is done here

JustinShenk commented 3 years ago

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 commented 3 years ago

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.