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

Update metadata docstrings #368

Merged
merged 32 commits into from
Nov 22, 2024
Merged
Show file tree
Hide file tree
Changes from 31 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
2904388
update docstrings in metadata_class.py and add more examples in set_i…
sjvenditto Nov 14, 2024
f6c4ed3
added more examples to get_info and set_info and tested with doctest.…
sjvenditto Nov 15, 2024
cef458d
TsdFrame init examples
sjvenditto Nov 15, 2024
293a9d6
docstring examples for tsgroup init
sjvenditto Nov 15, 2024
35d8a11
reorganize ts_group docstring, add docstrings for attributed without …
sjvenditto Nov 15, 2024
458b22b
first pass on metadata core methods for docs
sjvenditto Nov 18, 2024
df7e7f2
isort
sjvenditto Nov 19, 2024
6793901
move init docs of intervalset and tsdframe. add some property docstrings
sjvenditto Nov 19, 2024
1602339
collapse module in doc names
sjvenditto Nov 19, 2024
1425499
updates to core methods page
sjvenditto Nov 19, 2024
7943bc3
rearrange core methods sections, update metadata initialization examples
sjvenditto Nov 19, 2024
5bde477
Update 04_core_methods.md
sjvenditto Nov 19, 2024
39b4d05
fix HD tutorial
sjvenditto Nov 20, 2024
fd24a86
smallc hanges
gviejo Nov 20, 2024
16de010
remove redundant init docstrings
sjvenditto Nov 20, 2024
8c1ba66
Merge branch 'metadata' of https://github.com/pynapple-org/pynapple i…
sjvenditto Nov 20, 2024
a548b7d
decorator for adding metadata doc strings to allow for class-specific…
sjvenditto Nov 21, 2024
881bcbe
intervalset set_info examples
sjvenditto Nov 21, 2024
565e8d8
set_info examples for TsdFrame
sjvenditto Nov 21, 2024
3ca8672
move get_info examples to tsgroup
sjvenditto Nov 21, 2024
b11227e
get_info examples for intervalset
sjvenditto Nov 21, 2024
7bd540a
get_info examples for tsdframe
sjvenditto Nov 21, 2024
581df5b
Update ts_group.py
sjvenditto Nov 21, 2024
8d2de11
update core methods
sjvenditto Nov 21, 2024
8160b8d
override docs directly instead of methods to make tests happy
sjvenditto Nov 21, 2024
4e5280b
Update 04_core_methods.md
sjvenditto Nov 21, 2024
ea137b7
remove decorator
sjvenditto Nov 21, 2024
02f0739
Revert "remove decorator"
sjvenditto Nov 21, 2024
54b4c6c
Revert "override docs directly instead of methods to make tests happy"
sjvenditto Nov 21, 2024
13f6df6
revert to overriding functions and update test to make docs happy
sjvenditto Nov 21, 2024
3fb02dc
Update test_metadata.py
sjvenditto Nov 21, 2024
86ca812
Fixing a few typos
gviejo Nov 22, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@
/docs/generated/gallery/*.py
/docs/generated/gallery/*.zip

/doc/generated
/doc/examples/nwb-cache
/doc/_build

/tests/npzfilestest

# Byte-compiled / optimized / DLL files
Expand Down
12 changes: 6 additions & 6 deletions doc/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Core objects

.. rubric:: Time Series

.. currentmodule:: pynapple.core.time_series
.. currentmodule:: pynapple

.. autosummary::
:toctree: generated/
Expand All @@ -22,7 +22,7 @@ Core objects

.. rubric:: Intervals

.. currentmodule:: pynapple.core.interval_set
.. currentmodule:: pynapple

.. autosummary::
:toctree: generated/
Expand All @@ -34,7 +34,7 @@ Core objects

.. rubric:: Timestamps

.. currentmodule:: pynapple.core.time_series
.. currentmodule:: pynapple

.. autosummary::
:toctree: generated/
Expand All @@ -45,7 +45,7 @@ Core objects

.. rubric:: Group of timestamps

.. currentmodule:: pynapple.core.ts_group
.. currentmodule:: pynapple

.. autosummary::
:toctree: generated/
Expand All @@ -58,7 +58,7 @@ Core objects
Input-Ouput
-----------

.. currentmodule:: pynapple.io.interface_nwb
.. currentmodule:: pynapple.io

.. rubric:: Neurodata Without Borders (NWB)

Expand All @@ -70,7 +70,7 @@ Input-Ouput
NWBFile


.. currentmodule:: pynapple.io.interface_npz
.. currentmodule:: pynapple.io

.. rubric:: Numpy files

Expand Down
4 changes: 2 additions & 2 deletions doc/examples/tutorial_HD_dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ tuning_curves = nap.compute_1d_tuning_curves(
group=spikes_adn,
feature=angle,
nb_bins=61,
ep = epochs['wake'],
ep=epochs[epochs.tags == "wake"],
minmax=(0, 2 * np.pi)
)
```
Expand Down Expand Up @@ -199,7 +199,7 @@ To decode the population activity, we will be using a Bayesian Decoder as implem
decoded, proba_feature = nap.decode_1d(
tuning_curves=tuning_curves,
group=spikes_adn,
ep=epochs["wake"],
ep=epochs[epochs.tags == "wake"],
bin_size=0.1, # second
feature=angle,
)
Expand Down
Loading
Loading