VarIr / scikit-hubness

A Python package for hubness analysis and high-dimensional data mining
BSD 3-Clause "New" or "Revised" License
44 stars 10 forks source link

DOC user guide and examples #51

Closed VarIr closed 4 years ago

VarIr commented 4 years ago

Introduce a User Guide and Examples to the documentation.

lgtm-com[bot] commented 4 years ago

This pull request introduces 1 alert when merging c5bd40116349d265e516de15ced14ccb985717aa into 1ac193124f787d540a9a6a69d0888c16d094e503 - view on LGTM.com

new alerts:

codecov-io commented 4 years ago

Codecov Report

Merging #51 into master will increase coverage by 0.12%. The diff coverage is 99.11%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #51      +/-   ##
==========================================
+ Coverage   99.05%   99.17%   +0.12%     
==========================================
  Files          54       55       +1     
  Lines        4429     4491      +62     
  Branches      489      494       +5     
==========================================
+ Hits         4387     4454      +67     
+ Misses         22       18       -4     
+ Partials       20       19       -1
Impacted Files Coverage Δ
skhubness/neighbors/lsh.py 97.43% <ø> (ø) :arrow_up:
skhubness/data/tests/test_load_datasets.py 100% <ø> (ø) :arrow_up:
skhubness/neighbors/tests/test_base.py 100% <100%> (ø)
skhubness/neighbors/nng.py 100% <100%> (ø) :arrow_up:
...khubness/reduction/tests/test_hubness_reduction.py 100% <100%> (ø) :arrow_up:
skhubness/neighbors/tests/test_neighbors.py 99.68% <100%> (ø) :arrow_up:
skhubness/neighbors/hnsw.py 100% <100%> (ø) :arrow_up:
skhubness/reduction/__init__.py 100% <100%> (ø) :arrow_up:
skhubness/neighbors/tests/test_lof.py 100% <100%> (ø) :arrow_up:
skhubness/analysis/estimation.py 99.57% <100%> (ø) :arrow_up:
... 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 1ac1931...d8aeb8a. Read the comment docs.

VarIr commented 4 years ago

Closes #46