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

Simplify Vocabulary, add types module, and improve type documentation #465

Merged
merged 9 commits into from
Aug 6, 2024

Conversation

mdekstrand
Copy link
Member

This simplifies the Vocabulary class to no longer be generic, and introduces a lenskit.types module to hold various utility types, and uses these to improve type-level documentation.

@mdekstrand mdekstrand added internals Internal infrastructure (parallelism, math, etc.) data Data management support. labels Aug 5, 2024
@mdekstrand mdekstrand added this to the 2024.1 milestone Aug 5, 2024
@mdekstrand mdekstrand marked this pull request as ready for review August 5, 2024 22:25
Copy link

github-actions bot commented Aug 5, 2024

The GitHub 🤖 has run the tests on your PR.

Covered 87.88% of diff (coverage changed -0.21% from 92.52% to 92.31%).

origin/main...HEAD, staged and unstaged changes
  • lenskit-implicit/lenskit/implicit.py (100%)
  • lenskit/lenskit/algorithms/als/common.py (100%)
  • lenskit/lenskit/algorithms/knn/item.py (100%)
  • lenskit/lenskit/algorithms/knn/user.py (100%)
  • lenskit/lenskit/algorithms/svd.py (100%)
  • lenskit/lenskit/data/init.py (100%)
  • lenskit/lenskit/data/dataset.py (100%)
  • lenskit/lenskit/data/items.py (100%)
  • lenskit/lenskit/data/vocab.py (100%)
  • lenskit/lenskit/pipeline/init.py (100%)
  • lenskit/lenskit/splitting/holdout.py (100%)
  • lenskit/lenskit/splitting/records.py (100%)
  • lenskit/lenskit/splitting/split.py (100%)
  • lenskit/lenskit/splitting/users.py (100%)
  • lenskit/lenskit/types.py (68.4%): Missing lines 38-42,44,64-68,70

Summary

  • Total: 99 lines
  • Missing: 12 lines
  • Coverage: 87%
Source Coverage Report
Name Stmts Miss Cover
lenskit-funksvd/lenskit/funksvd.py 187 8 96%
lenskit-hpf/lenskit/hpf.py 24 0 100%
lenskit-implicit/lenskit/implicit.py 94 9 90%
lenskit/lenskit/algorithms/__init__.py 67 8 88%
lenskit/lenskit/algorithms/als/__init__.py 3 0 100%
lenskit/lenskit/algorithms/als/common.py 128 2 98%
lenskit/lenskit/algorithms/als/explicit.py 121 3 98%
lenskit/lenskit/algorithms/als/implicit.py 112 1 99%
lenskit/lenskit/algorithms/basic.py 161 4 98%
lenskit/lenskit/algorithms/bias.py 150 3 98%
lenskit/lenskit/algorithms/knn/__init__.py 3 0 100%
lenskit/lenskit/algorithms/knn/item.py 303 17 94%
lenskit/lenskit/algorithms/knn/user.py 178 11 94%
lenskit/lenskit/algorithms/mf_common.py 61 0 100%
lenskit/lenskit/algorithms/ranking.py 75 11 85%
lenskit/lenskit/algorithms/svd.py 75 4 95%
lenskit/lenskit/batch/__init__.py 2 0 100%
lenskit/lenskit/batch/_predict.py 30 2 93%
lenskit/lenskit/batch/_recommend.py 46 4 91%
lenskit/lenskit/crossfold.py 136 2 99%
lenskit/lenskit/data/__init__.py 10 0 100%
lenskit/lenskit/data/checks.py 37 0 100%
lenskit/lenskit/data/dataset.py 364 19 95%
lenskit/lenskit/data/fetch.py 38 28 26%
lenskit/lenskit/data/items.py 176 11 94%
lenskit/lenskit/data/matrix.py 115 5 96%
lenskit/lenskit/data/movielens.py 96 18 81%
lenskit/lenskit/data/mtarray.py 57 3 95%
lenskit/lenskit/data/tables.py 25 0 100%
lenskit/lenskit/data/vocab.py 84 7 92%
lenskit/lenskit/diagnostics.py 4 0 100%
lenskit/lenskit/math/__init__.py 0 0 100%
lenskit/lenskit/math/solve.py 6 0 100%
lenskit/lenskit/metrics/__init__.py 0 0 100%
lenskit/lenskit/metrics/predict.py 32 0 100%
lenskit/lenskit/metrics/topn.py 212 1 99%
lenskit/lenskit/parallel/__init__.py 4 0 100%
lenskit/lenskit/parallel/chunking.py 20 1 95%
lenskit/lenskit/parallel/config.py 65 8 88%
lenskit/lenskit/parallel/invoker.py 31 2 94%
lenskit/lenskit/parallel/pool.py 54 9 83%
lenskit/lenskit/parallel/sequential.py 22 0 100%
lenskit/lenskit/parallel/serialize.py 51 1 98%
lenskit/lenskit/parallel/worker.py 43 3 93%
lenskit/lenskit/pipeline/__init__.py 177 8 95%
lenskit/lenskit/pipeline/common.py 5 1 80%
lenskit/lenskit/pipeline/components.py 25 0 100%
lenskit/lenskit/pipeline/nodes.py 49 1 98%
lenskit/lenskit/pipeline/runner.py 84 1 99%
lenskit/lenskit/pipeline/types.py 56 2 96%
lenskit/lenskit/splitting/__init__.py 4 0 100%
lenskit/lenskit/splitting/holdout.py 56 4 93%
lenskit/lenskit/splitting/records.py 56 0 100%
lenskit/lenskit/splitting/split.py 27 6 78%
lenskit/lenskit/splitting/users.py 60 0 100%
lenskit/lenskit/topn.py 109 25 77%
lenskit/lenskit/types.py 38 12 68%
lenskit/lenskit/util/__init__.py 72 19 74%
lenskit/lenskit/util/envcheck.py 57 44 23%
lenskit/lenskit/util/logging.py 19 0 100%
lenskit/lenskit/util/random.py 26 3 88%
lenskit/lenskit/util/test.py 103 19 82%
lenskit/lenskit/util/timing.py 28 0 100%
TOTAL 4553 350 92%

@mdekstrand mdekstrand merged commit 967655d into lenskit:main Aug 6, 2024
38 checks passed
@mdekstrand mdekstrand deleted the feature/type-docs branch August 6, 2024 00:03
@mdekstrand mdekstrand changed the title Simply Vocabulary, add types module, and improve type documentation Simplify Vocabulary, add types module, and improve type documentation Aug 6, 2024
@mdekstrand mdekstrand removed the internals Internal infrastructure (parallelism, math, etc.) label Aug 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
data Data management support.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant