models icon indicating copy to clipboard operation
models copied to clipboard

[DOC] Docstring coverage in Models

Open karlhigley opened this issue 3 years ago • 0 comments

Modules with missing docstrings:

  • [ ] config, data
  • [ ] loader
  • [ ] tf/blocks
  • [ ] tf/features, tf/losses, tf/metrics
  • [ ] tf/prediction_tasks
  • [ ] tf/utils
  • [ ] torch
  • [ ] utils
Name Total Miss Cover Cover%
merlin/models/mypy.py 5 5 0 0%
merlin/models/config/schema.py 6 6 0 0%
merlin/models/data/synthetic.py 9 6 3 33%
merlin/models/loader/backend.py 13 11 2 15%
merlin/models/loader/dataframe_iter.py 1 1 0 0%
merlin/models/loader/shuffle.py 1 1 0 0%
merlin/models/loader/tf_utils.py 2 1 1 50%
merlin/models/loader/utils.py 1 1 0 0%
merlin/models/tf/dataset.py 4 2 2 50%
merlin/models/tf/blocks/cross.py 7 5 2 29%
merlin/models/tf/blocks/dlrm.py 2 1 1 50%
merlin/models/tf/blocks/experts.py 13 13 0 0%
merlin/models/tf/blocks/interaction.py 13 9 4 31%
merlin/models/tf/blocks/mlp.py 8 6 2 25%
merlin/models/tf/blocks/core/aggregation.py 39 35 4 10%
merlin/models/tf/blocks/core/base.py 42 31 11 26%
merlin/models/tf/blocks/core/combinators.py 23 21 2 9%
merlin/models/tf/blocks/core/index.py 14 9 5 36%
merlin/models/tf/blocks/core/masking.py 15 10 5 33%
merlin/models/tf/blocks/core/tabular.py 34 25 9 26%
merlin/models/tf/blocks/core/transformations.py 47 42 5 11%
merlin/models/tf/blocks/retrieval/base.py 17 14 3 18%
merlin/models/tf/blocks/retrieval/matrix_factorization.py 4 4 0 0%
merlin/models/tf/blocks/sampling/base.py 4 4 0 0%
merlin/models/tf/blocks/sampling/cross_batch.py 11 6 5 45%
merlin/models/tf/blocks/sampling/in_batch.py 6 4 2 33%
merlin/models/tf/features/continuous.py 7 6 1 14%
merlin/models/tf/features/embedding.py 22 20 2 9%
merlin/models/tf/losses/base.py 1 1 0 0%
merlin/models/tf/metrics/ranking.py 17 11 6 35%
merlin/models/tf/models/base.py 36 28 8 22%
merlin/models/tf/models/ranking.py 4 1 3 75%
merlin/models/tf/models/utils.py 1 1 0 0%
merlin/models/tf/prediction_tasks/base.py 29 27 2 7%
merlin/models/tf/prediction_tasks/classification.py 15 15 0 0%
merlin/models/tf/prediction_tasks/multi.py 1 1 0 0%
merlin/models/tf/prediction_tasks/next_item.py 3 1 2 67%
merlin/models/tf/prediction_tasks/regression.py 4 4 0 0%
merlin/models/tf/prediction_tasks/retrieval.py 2 1 1 50%
merlin/models/tf/utils/batch_utils.py 8 8 0 0%
merlin/models/tf/utils/mixins.py 10 4 6 60%
merlin/models/tf/utils/repr_utils.py 5 5 0 0%
merlin/models/tf/utils/testing_utils.py 7 7 0 0%
merlin/models/tf/utils/tf_utils.py 13 11 2 15%
merlin/models/torch/losses.py 2 1 1 50%
merlin/models/torch/block/base.py 19 19 0 0%
merlin/models/torch/block/mlp.py 4 4 0 0%
merlin/models/torch/features/base.py 1 1 0 0%
merlin/models/torch/features/continuous.py 4 3 1 25%
merlin/models/torch/features/embedding.py 15 10 5 33%
merlin/models/torch/features/tabular.py 4 1 3 75%
merlin/models/torch/model/base.py 32 24 8 25%
merlin/models/torch/model/prediction_task.py 6 6 0 0%
merlin/models/torch/tabular/aggregation.py 13 9 4 31%
merlin/models/torch/tabular/base.py 29 15 14 48%
merlin/models/torch/tabular/transformations.py 9 7 2 22%
merlin/models/torch/utils/data_utils.py 14 9 5 36%
merlin/models/torch/utils/torch_utils.py 20 14 6 30%
merlin/models/utils/dataset.py 2 1 1 50%
merlin/models/utils/dependencies.py 3 3 0 0%
merlin/models/utils/doc_utils.py 1 1 0 0%
merlin/models/utils/misc_utils.py 9 4 5 56%
merlin/models/utils/registry.py 19 12 7 37%
merlin/models/utils/schema_utils.py 10 9 1 10%
TOTAL 805 578 227 28.2%
(11 of 75 files omitted due to complete coverage)

karlhigley avatar Mar 23 '22 19:03 karlhigley