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 detailed tutorials #62

Merged
merged 8 commits into from
Oct 25, 2020
Merged

Add detailed tutorials #62

merged 8 commits into from
Oct 25, 2020

Conversation

SarthakJariwala
Copy link
Owner

@SarthakJariwala SarthakJariwala commented Oct 19, 2020

This PR adds detailed tutorials showing different examples :

  • Write detailed jupyter notebooks for all different functionalities in seaborn-image

    • General image visualization

    • Image filters - individual, grid and related functions (TO ADD - commentary)

    • Image Distribution --- basic example

    • Working with RGB images

    • Image Grid - multiple images and multi-dimensional image --- basic example

Closes #35

This PR also significantly improves plotting speed by removing tight_layout() from _core.py

@SarthakJariwala SarthakJariwala added the documentation Improvements or additions to documentation label Oct 19, 2020
@SarthakJariwala SarthakJariwala added this to the v0.4 milestone Oct 19, 2020
@codecov-io
Copy link

codecov-io commented Oct 21, 2020

Codecov Report

Merging #62 into master will increase coverage by 0.05%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #62      +/-   ##
==========================================
+ Coverage   94.58%   94.64%   +0.05%     
==========================================
  Files           8        8              
  Lines         646      653       +7     
  Branches      156      157       +1     
==========================================
+ Hits          611      618       +7     
  Misses         18       18              
  Partials       17       17              
Impacted Files Coverage Δ
src/seaborn_image/_core.py 93.22% <ø> (-0.06%) ⬇️
src/seaborn_image/utils.py 91.04% <100.00%> (+1.21%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a926d0b...86b9bad. Read the comment docs.

@SarthakJariwala SarthakJariwala merged commit 6d2a13a into master Oct 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Tutorials to the documentation website
2 participants