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

docs: introduce MosaicViews as dataset preview utils #82

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

johnnychen94
Copy link
Member

No description provided.

@codecov-commenter
Copy link

codecov-commenter commented Oct 29, 2021

Codecov Report

Merging #82 (d1ab622) into master (cd5751f) will increase coverage by 9.25%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #82      +/-   ##
==========================================
+ Coverage   21.06%   30.31%   +9.25%     
==========================================
  Files          30       32       +2     
  Lines         679      795     +116     
==========================================
+ Hits          143      241      +98     
- Misses        536      554      +18     
Impacted Files Coverage Δ
src/MNIST/utils.jl 85.71% <0.00%> (-4.29%) ⬇️
src/CIFAR10/interface.jl 1.23% <0.00%> (-0.07%) ⬇️
src/CoNLL.jl 0.00% <0.00%> (ø)
src/planetoid.jl 100.00% <0.00%> (ø)
src/CIFAR100/interface.jl 0.00% <0.00%> (ø)
src/CIFAR10/Reader/Reader.jl 0.00% <0.00%> (ø)
src/CIFAR100/Reader/Reader.jl 0.00% <0.00%> (ø)
src/MNIST/Reader/readimages.jl 0.00% <0.00%> (ø)
src/MNIST/Reader/readlabels.jl 0.00% <0.00%> (ø)
src/Mutagenesis/Mutagenesis.jl 97.29% <0.00%> (ø)
... and 3 more

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 cd5751f...d1ab622. Read the comment docs.

When building documentation locally we need to manually do `]dev .` to tell
Julia use dev version of MLDatasets, and this immediately updates the
Project.toml file, to keep it complete I commit this change . This change won't
affect docs CI.
@johnnychen94
Copy link
Member Author

┌ Warning: failed to run `@example` block in src/index.md:64-74
│ ```@example
│ using MLDatasets
│ using ImageCore
│ 
│ # The original dataset is stored in row-major order, to display it
│ # normally in Julia, we need to permute the first two dimensions.
│ test_x = Gray.(PermutedDimsArray(MNIST.testtensor(), (2, 1, 3)));
│ test_x_sample = @view test_x[:, :, 1:64];
│ 
│ mosaic(test_x_sample, nrow=8)
│ ```
│   c.value = IOError: Could not open stream.
└ @ Documenter.Expanders ~/.julia/packages/Documenter/qdbx6/src/Expanders.jl:591

Hmmm, any ideas why the documentation CI is complaining? I get it working locally

preview.png

Comment on lines +61 to +62
For image dataset, [`MosaicViews`](https://github.com/JuliaArrays/MosaicViews.jl) provides a very simple interface to display a list
of images.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The fact that MosaicViews is not directly used in the code below is a bit confusing.
Maybe we can just point to the mosaic function from ImageCore.

@CarloLucibello
Copy link
Member

no idea why Documentation CI is failing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants