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.

Sign up for GitHub

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

Jump to bottom

Doc typos #398

Closed
miltminz opened this issue Apr 14, 2020 · 4 comments
Closed

Doc typos #398

miltminz opened this issue Apr 14, 2020 · 4 comments
Assignees
@ammedmar
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@miltminz
Copy link

Section Theory Glossary - Homology

Persistence landscape
Line 6: :math:k

Weighted silhouette
Line 2: :math:D weighted by :math:w
Line 6: :math:p
@ulupo
Copy link
Contributor

ulupo commented Apr 14, 2020

@ammedmar would you mind slotting some fixes in #394 ? The point is that while surrounding math environments with \textit works in pure LaTeX, it does not play well with pandoc's way of generating the RST files which are uploaded to the web.

@ulupo ulupo added documentation Improvements or additions to documentation bug Something isn't working labels Apr 14, 2020
@ammedmar ammedmar mentioned this issue Apr 14, 2020
Merged
@ammedmar
Copy link
Collaborator

Noted. Fixes in PR #394

ammedmar added a commit that referenced this issue Apr 17, 2020
@ammedmar
Toc (#394)
44c7ca8 
* Update P landscapes

Signed-off-by: ammedmar <anibal@medina-mardones.com>

* Add distances, inner products and kernels glossary entry

Signed-off-by: ammedmar <anibal@medina-mardones.com>

* Remake vectorization changes

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Change [] for \lbrack \rbrack

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update after W's comments

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update after W's comments

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update afte W's second comments

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update after Umbe's comments

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update after Umbe's second comments

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update after Umbe's third comments

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update after Umbe's 4th comments

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Remove concept k-skeleton

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Add table of content

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Add Lp & lp. Update landscape

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update TOC indentation

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Add heat vectorizations entry

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update indentation of TOC

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Fix extra spacing in bibliography

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update bibliography hack for caps

Signed-off-by: ammedmar <ammedmar@gmail.com>

* After Umbe's Comments

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update after issue #398

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update after Umbe's comments

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update after Umbe's 2nd comments

Signed-off-by: ammedmar <ammedmar@gmail.com>

Co-authored-by: ammedmar <anibal@medina-mardones.com>
@ammedmar
Copy link
Collaborator

Should I close this issue? Now that the fix is merged?

@ulupo
Copy link
Contributor

ulupo commented Apr 17, 2020

@ammedmar I believe so!

ulupo added a commit that referenced this issue Jun 2, 2020
@ulupo @ammedmar
@reds-heig @gtauzin
Create giotto-tda v0.2.2 (#414)
a0f709b 
* Fix issue with docstring example and document reshaping of 1D outputs (#396)

* Toc (#394)

* Update P landscapes

Signed-off-by: ammedmar <anibal@medina-mardones.com>

* Add distances, inner products and kernels glossary entry

Signed-off-by: ammedmar <anibal@medina-mardones.com>

* Remake vectorization changes

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Change [] for \lbrack \rbrack

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update after W's comments

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update after W's comments

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update afte W's second comments

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update after Umbe's comments

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update after Umbe's second comments

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update after Umbe's third comments

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update after Umbe's 4th comments

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Remove concept k-skeleton

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Add table of content

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Add Lp & lp. Update landscape

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update TOC indentation

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Add heat vectorizations entry

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update indentation of TOC

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Fix extra spacing in bibliography

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update bibliography hack for caps

Signed-off-by: ammedmar <ammedmar@gmail.com>

* After Umbe's Comments

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update after issue #398

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update after Umbe's comments

Signed-off-by: ammedmar <ammedmar@gmail.com>

* Update after Umbe's 2nd comments

Signed-off-by: ammedmar <ammedmar@gmail.com>

Co-authored-by: ammedmar <anibal@medina-mardones.com>

* Speedup windows pipeline (#402)

* Improve boost location for azure pipeline on windows

The boost version installed in the pipeline is now used

Signed-off-by: julian <julian.burellaperez@heig-vd.ch>
Co-authored-by: Umberto Lupo <46537483+ulupo@users.noreply.github.com>

* Make bindings public (#395)

* Make bindings public

Signed-off-by: Guillaume Tauzin <guillaumetauzin.ut@gmail.com>

* Fix pipeline on Mac (#407)

* Refresh ccache

* Enforce CXX standard to 14 on each module

* Change variable name to comply with E741

Signed-off-by: julian <julian.burellaperez@heig-vd.ch>
Co-authored-by: Umberto Lupo <46537483+ulupo@users.noreply.github.com>

* Mapper visualisation refactor: fix bugs, add summary statistics in hovertext, improve opacity, remove matplotlib dependency, add node_scale kwarg, add clone_pipeline kwarg to interactive plots,restructure/rename plotly_kwargs, improve code (#406)

* Refactor of `mapper/visualisation.py` and `mapper/utils/visualisation.py`
- Removal of color scaling
- More modularity
- Variable and function name changes
- Remove matplotlib functions used for hoverlabel background color
- Remove cmin and cmax
- Change return signature of some functions

* Add test-output.xml to .gitignore

* Replace "text" key in plot_options["node_trace"] with "hovertext"

* Improve width and opacity of nodes and edges

* Display summary statistics in hovertext with significant figure rounding via new n_sig_figs kwarg

* Rename plotly_kwargs to plotly_params

* Remove matplotlib installation requirement

* Fix mapper notebook

* Add small comment on use of matplotlib in voids_on_the_plane

* Place matplotlib in examples requirement in setup.py

* Improve docstring of make_mapper_pipeline

* Improve examples for make_mapper_pipeline and create one for plot_static_mapper_graph

* Hide set_node_sizeref, add node_scale kwarg, add clone_pipeline kwarg to plot_interactive_mapper_graph

- Update docstrings
- Update quickstart notebook

* Add helper function for colorscale-based interpolations, improve use of plotly_params

Static and interactive plots display the expect hoverlabel colors in 3D, or white if things go wrong. Thanks to @lewtun for pointing out that this was needed.

* Improve docstrings

* Hide visualization module in mapper/utils

* Add pip install matplotlib to notebook tests in manylinux job (#410)

* Fix mapper docstring issues following #406 (#411)

* Fix issues with mapper docs following #406

* Create giotto-tda version 0.2.2 (#413)

* Turn CODE_OWNERS and CODE_AUTHORS into an rst file

* Bump version number to 0.2.2

* Add release notes for v0.2.2

Co-authored-by: Anibal M. Medina-Mardones <ammedmar@gmail.com>
Co-authored-by: ammedmar <anibal@medina-mardones.com>
Co-authored-by: REDS institute <reds-heig@users.noreply.github.com>
Co-authored-by: Guillaume Tauzin <guillaumetauzin.ut@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ammedmar ammedmar

Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@miltminz @ammedmar @ulupo