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

Dev aifpaif #152

Merged
merged 22 commits into from
Feb 6, 2024
Merged

Dev aifpaif #152

merged 22 commits into from
Feb 6, 2024

Conversation

Frederic-vW
Copy link
Contributor

entropy tutorial v1.0

@vferat
Copy link
Owner

vferat commented Jan 31, 2024

Hey @Frederic-vW,

Thanks a lot for the tutorial !
I changed the file format from .ipynb to .py and adjusted the synthax accordingly:

  • I added references to our bibfile
  • I updated some lateX formulas so sphinx renders them correctly

Would you like to include your email and name at the top of the tutorial ?

# Authors: Frederic von Wegner <_@_._>
#          Victor Férat <[email protected]>

You can check the results here:
https://pycrostates--152.org.readthedocs.build/en/152/generated/auto_tutorials/segmentation/10_entropy.html#sphx-glr-generated-auto-tutorials-segmentation-10-entropy-py

Let me know if it looks good for you !

I will then merge this PR to #112 and merge #112 to main to include changes in the next release.

@mscheltienne
Copy link
Collaborator

Thanks for the tutorial!
I can review on Monday, maybe when it's merged into #112?

@vferat
Copy link
Owner

vferat commented Feb 6, 2024

@all-contributors please add @Frederic-vW for code tutorial review

Copy link
Contributor

@vferat

I've put up a pull request to add @Frederic-vW! 🎉

@vferat vferat merged commit ab7ac25 into vferat:dev-aifpaif Feb 6, 2024
19 checks passed
vferat added a commit that referenced this pull request Feb 13, 2024
* Add autoinformation

Add code from https://github.com/Frederic-vW/AIF-PAIF

* wip

* wip

* WIP

* Update autoinformation.py

* wip

* Change entropy to use joint_entropy_history for easier maintenance

* Add ais, aif, paif

Finish implementation skeleton and test against original lib

* wip

* [wip] Add excess_entropy_rate

* WIP

* WIP

* WIP

* WIP

* Fix style

* Add changes to changelog

* Fix residuals

* WIP

* WIP

* WIP

* Fix style

* fix style

* Fix import

* Fix docs (wip)

* Fix style and docs

* clean-up and fix type-hints in entropy

* Update docs/source/dev/changes/latest.rst

Co-authored-by: Mathieu Scheltienne <[email protected]>

* Update pycrostates/segmentation/_base.py

Co-authored-by: Mathieu Scheltienne <[email protected]>

* Fix @mscheltienne review

* Update _typing.py

* Update docs/source/dev/changes/latest.rst

Co-authored-by: Mathieu Scheltienne <[email protected]>

* refractor public and private API

* Fix unused import

* Fix bib file

* Fix segmentation.entropy

* Fix docstring

* Fix test name

* Fix footcite ?

* Use :t: instead of :p:

* Fix citation in autosummary

* Change ignore_self to ignore_repetitions

* Add ignore_repetitions docstring

* Deprecate ignore_self in favour of ignore_repetitions

* Add test for deprecated

* Fix style

* Fix docs

* nitpick and typos

* better deprecation

* tutorial fixes

* fix tutorial title

* fix more

* fix ruff

* rm deprecation test function

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Add state_to_ignore in docdict

* Add log_base and labels_info to docdict

* Add segmentation to docdict

* Dev aifpaif (#152)

* updating 10_entropy notebook

* updating 10_entropy notebook

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update tutorial

export ipynb to .py
Add references

* Update 10_entropy.py

* Update 10_entropy.py

* Update 10_entropy.py

* Update 10_entropy.py

* Update 10_entropy.py

* Update 10_entropy.py

* Update 10_entropy.py

* Update 10_entropy.py

* Update 10_entropy.py

* updating 10_entropy notebook

* Add authors

* Update 10_entropy.py

* Update 10_entropy.py

* Update 10_entropy.py

---------

Co-authored-by: “Frederic-vW” <“[email protected]”>
Co-authored-by: Victor Férat <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* rm file =61.0.0

* better docstring format

* rm unused bibliographic item

* clean-up tutorial format

* better documentation makefiles

* a couple more clean-ups

* better documentation build configuration

* fix missed

* fix dead links

* fix missed

* Add optipng dependency

* Update .readthedocs.yaml

---------

Co-authored-by: Mathieu Scheltienne <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Frederic-vW <[email protected]>
Co-authored-by: “Frederic-vW” <“[email protected]”>
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.

3 participants