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

Usage docs and style fixes #31

Merged
merged 39 commits into from
Apr 14, 2021
Merged

Usage docs and style fixes #31

merged 39 commits into from
Apr 14, 2021

Conversation

trangtran72
Copy link
Collaborator

No description provided.

@trangtran72 trangtran72 added the enhancement New feature or request label Mar 3, 2021
@trangtran72 trangtran72 linked an issue Mar 3, 2021 that may be closed by this pull request
Put example usage into docstrings #26
Closed
@trangtran72 trangtran72 removed a link to an issue Mar 3, 2021
Put example usage into docstrings #26
Closed
@trangtran72 trangtran72 linked an issue Mar 3, 2021 that may be closed by this pull request
Usage Documentation #23
Open
@trangtran72 trangtran72 self-assigned this Mar 3, 2021
@codecov-io

This comment has been minimized.

Sign in to view
@trangtran72 trangtran72 added the documentation Improvements or additions to documentation label Mar 3, 2021
@trangtran72
Copy link
Collaborator Author

Need to provide a full example (from initialization to training) in the ipynb. All the docs about different parameterizations should stay within the docstrings only.

@github-actions

This comment has been minimized.

Sign in to view
@trangtran72 trangtran72 linked an issue Mar 10, 2021 that may be closed by this pull request
Put example usage into docstrings #26
Closed
@github-actions

This comment has been minimized.

Sign in to view
@github-actions

This comment has been minimized.

Sign in to view
@trangtran72 trangtran72 requested a review from dhruvdcoder March 10, 2021 14:20
@dhruvdcoder dhruvdcoder requested a review from mboratko March 10, 2021 14:56
@github-actions
Copy link

Docstrings Coverage Report

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/init.py"

  • No module docstring
  • No docstring for torch_is_available
  • No docstring for tensorflow_is_available
    Needed: 3; Found: 0; Missing: 3; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/registrable.py"

  • No docstring for register.foo
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/tf_utils.py"

  • No module docstring
  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
    Needed: 10; Found: 7; Missing: 3; Coverage: 70.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/utils.py"

  • No module docstring
  • No docstring for softplus_inverse
  • No docstring for inv_sigmoid
    Needed: 7; Found: 4; Missing: 3; Coverage: 57.1%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/initializer.py"

  • No module docstring
  • No docstring for BoxInitializer.__call__
  • No docstring for BoxInitializer.__repr__
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/gumbel_intersection.py"

  • No module docstring
  • No docstring for _compute_logaddexp_with_clipping_and_separate_forward
  • No docstring for _compute_logaddexp_with_clipping
  • No docstring for _compute_logaddexp
    Needed: 8; Found: 4; Missing: 4; Coverage: 50.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/bag_of_boxes.py"

  • No module docstring
  • No docstring for bag_of_boxes_pooler
  • No docstring for BagOfBoxesBoxPooler.__init__
    Needed: 5; Found: 2; Missing: 3; Coverage: 40.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/intersection.py"

  • No module docstring
  • No docstring for hard_intersection_pooler
  • No docstring for HardIntersectionBoxPooler.__init__
  • No docstring for HardIntersectionBoxPooler.forward
    Needed: 5; Found: 1; Missing: 4; Coverage: 20.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/hard_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_box_tensor.py"

  • No docstring for TFBoxTensor.__repr__
  • No docstring for TFBoxTensor.args
  • No docstring for TFBoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for TFBoxFactory.__call__
    Needed: 22; Found: 17; Missing: 5; Coverage: 77.3%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/setup.py"

  • No module docstring
  • No docstring for load_requirements
    Needed: 2; Found: 0; Missing: 2; Coverage: 0.0%

Overall statistics for 20 files (1 files are empty):
Needed: 107 - Found: 70 - Missing: 37
Total coverage: 65.4% - Grade: Good

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/constant.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/uniform_boxes.py"

  • No module docstring
  • No docstring for UniformBoxInitializer.__call__
    Needed: 5; Found: 3; Missing: 2; Coverage: 60.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/box_module.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/embedding.py"

  • No module docstring
  • No docstring for BoxEmbedding.__init__
  • No docstring for BoxEmbedding.forward
  • No docstring for BoxEmbedding.all_boxes
  • No docstring for BoxEmbedding.get_bounding_box
    Needed: 6; Found: 1; Missing: 5; Coverage: 16.7%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/_intersection.py"

  • No module docstring
  • No docstring for _Intersection.forward
  • No docstring for _Intersection._forward
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/hard_intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/pooling.py"

  • No module docstring
  • No docstring for BoxPooler.forward
    Needed: 3; Found: 1; Missing: 2; Coverage: 33.3%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/l2_side_regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/bessel_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/soft_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/box_tensor.py"

  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
  • No docstring for BoxTensor.__repr__
  • No docstring for BoxTensor.__eq__
  • No docstring for BoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for BoxFactory.__call__
    Needed: 28; Found: 21; Missing: 7; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/delta_box_tensor.py"

  • No docstring for MinDeltaBoxTensor.kwargs
  • No docstring for MinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_delta_box_tensor.py"

  • No docstring for TFMinDeltaBoxTensor.kwargs
  • No docstring for TFMinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

Overall statistics for 20 files (2 files are empty):
Needed: 100 - Found: 67 - Missing: 33
Total coverage: 67.0% - Grade: Good

@github-actions
Copy link

Docstrings Coverage Report

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/init.py"

  • No module docstring
  • No docstring for torch_is_available
  • No docstring for tensorflow_is_available
    Needed: 3; Found: 0; Missing: 3; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/registrable.py"

  • No docstring for register.foo
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/tf_utils.py"

  • No module docstring
  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
    Needed: 10; Found: 7; Missing: 3; Coverage: 70.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/utils.py"

  • No module docstring
  • No docstring for softplus_inverse
  • No docstring for inv_sigmoid
    Needed: 7; Found: 4; Missing: 3; Coverage: 57.1%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/initializer.py"

  • No module docstring
  • No docstring for BoxInitializer.__call__
  • No docstring for BoxInitializer.__repr__
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/gumbel_intersection.py"

  • No module docstring
  • No docstring for _compute_logaddexp_with_clipping_and_separate_forward
  • No docstring for _compute_logaddexp_with_clipping
  • No docstring for _compute_logaddexp
    Needed: 8; Found: 4; Missing: 4; Coverage: 50.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/bag_of_boxes.py"

  • No module docstring
  • No docstring for bag_of_boxes_pooler
  • No docstring for BagOfBoxesBoxPooler.__init__
    Needed: 5; Found: 2; Missing: 3; Coverage: 40.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/intersection.py"

  • No module docstring
  • No docstring for hard_intersection_pooler
  • No docstring for HardIntersectionBoxPooler.__init__
  • No docstring for HardIntersectionBoxPooler.forward
    Needed: 5; Found: 1; Missing: 4; Coverage: 20.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/hard_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_box_tensor.py"

  • No docstring for TFBoxTensor.__repr__
  • No docstring for TFBoxTensor.args
  • No docstring for TFBoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for TFBoxFactory.__call__
    Needed: 22; Found: 17; Missing: 5; Coverage: 77.3%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/setup.py"

  • No module docstring
  • No docstring for load_requirements
    Needed: 2; Found: 0; Missing: 2; Coverage: 0.0%

Overall statistics for 20 files (1 files are empty):
Needed: 107 - Found: 70 - Missing: 37
Total coverage: 65.4% - Grade: Good

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/constant.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/uniform_boxes.py"

  • No module docstring
  • No docstring for UniformBoxInitializer.__call__
    Needed: 5; Found: 3; Missing: 2; Coverage: 60.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/box_module.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/embedding.py"

  • No module docstring
  • No docstring for BoxEmbedding.__init__
  • No docstring for BoxEmbedding.forward
  • No docstring for BoxEmbedding.all_boxes
  • No docstring for BoxEmbedding.get_bounding_box
    Needed: 6; Found: 1; Missing: 5; Coverage: 16.7%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/_intersection.py"

  • No module docstring
  • No docstring for _Intersection.forward
  • No docstring for _Intersection._forward
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/hard_intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/pooling.py"

  • No module docstring
  • No docstring for BoxPooler.forward
    Needed: 3; Found: 1; Missing: 2; Coverage: 33.3%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/l2_side_regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/bessel_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/soft_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/box_tensor.py"

  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
  • No docstring for BoxTensor.__repr__
  • No docstring for BoxTensor.__eq__
  • No docstring for BoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for BoxFactory.__call__
    Needed: 28; Found: 21; Missing: 7; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/delta_box_tensor.py"

  • No docstring for MinDeltaBoxTensor.kwargs
  • No docstring for MinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_delta_box_tensor.py"

  • No docstring for TFMinDeltaBoxTensor.kwargs
  • No docstring for TFMinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

Overall statistics for 20 files (2 files are empty):
Needed: 100 - Found: 67 - Missing: 33
Total coverage: 67.0% - Grade: Good

@github-actions
Copy link

Docstrings Coverage Report

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/init.py"

  • No module docstring
  • No docstring for torch_is_available
  • No docstring for tensorflow_is_available
    Needed: 3; Found: 0; Missing: 3; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/registrable.py"

  • No docstring for register.foo
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/tf_utils.py"

  • No module docstring
  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
    Needed: 10; Found: 7; Missing: 3; Coverage: 70.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/utils.py"

  • No module docstring
  • No docstring for softplus_inverse
  • No docstring for inv_sigmoid
    Needed: 7; Found: 4; Missing: 3; Coverage: 57.1%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/initializer.py"

  • No module docstring
  • No docstring for BoxInitializer.__call__
  • No docstring for BoxInitializer.__repr__
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/gumbel_intersection.py"

  • No module docstring
  • No docstring for _compute_logaddexp_with_clipping_and_separate_forward
  • No docstring for _compute_logaddexp_with_clipping
  • No docstring for _compute_logaddexp
    Needed: 8; Found: 4; Missing: 4; Coverage: 50.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/bag_of_boxes.py"

  • No module docstring
  • No docstring for bag_of_boxes_pooler
  • No docstring for BagOfBoxesBoxPooler.__init__
    Needed: 5; Found: 2; Missing: 3; Coverage: 40.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/intersection.py"

  • No module docstring
  • No docstring for hard_intersection_pooler
  • No docstring for HardIntersectionBoxPooler.__init__
  • No docstring for HardIntersectionBoxPooler.forward
    Needed: 5; Found: 1; Missing: 4; Coverage: 20.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/hard_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_box_tensor.py"

  • No docstring for TFBoxTensor.__repr__
  • No docstring for TFBoxTensor.args
  • No docstring for TFBoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for TFBoxFactory.__call__
    Needed: 22; Found: 17; Missing: 5; Coverage: 77.3%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/setup.py"

  • No module docstring
  • No docstring for load_requirements
    Needed: 2; Found: 0; Missing: 2; Coverage: 0.0%

Overall statistics for 20 files (1 files are empty):
Needed: 107 - Found: 70 - Missing: 37
Total coverage: 65.4% - Grade: Good

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/constant.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/uniform_boxes.py"

  • No module docstring
  • No docstring for UniformBoxInitializer.__call__
    Needed: 5; Found: 3; Missing: 2; Coverage: 60.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/box_module.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/embedding.py"

  • No module docstring
  • No docstring for BoxEmbedding.__init__
  • No docstring for BoxEmbedding.forward
  • No docstring for BoxEmbedding.all_boxes
  • No docstring for BoxEmbedding.get_bounding_box
    Needed: 6; Found: 1; Missing: 5; Coverage: 16.7%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/_intersection.py"

  • No module docstring
  • No docstring for _Intersection.forward
  • No docstring for _Intersection._forward
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/hard_intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/pooling.py"

  • No module docstring
  • No docstring for BoxPooler.forward
    Needed: 3; Found: 1; Missing: 2; Coverage: 33.3%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/l2_side_regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/bessel_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/soft_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/box_tensor.py"

  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
  • No docstring for BoxTensor.__repr__
  • No docstring for BoxTensor.__eq__
  • No docstring for BoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for BoxFactory.__call__
    Needed: 28; Found: 21; Missing: 7; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/delta_box_tensor.py"

  • No docstring for MinDeltaBoxTensor.kwargs
  • No docstring for MinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_delta_box_tensor.py"

  • No docstring for TFMinDeltaBoxTensor.kwargs
  • No docstring for TFMinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

Overall statistics for 20 files (2 files are empty):
Needed: 100 - Found: 67 - Missing: 33
Total coverage: 67.0% - Grade: Good

1 similar comment
@github-actions
Copy link

Docstrings Coverage Report

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/init.py"

  • No module docstring
  • No docstring for torch_is_available
  • No docstring for tensorflow_is_available
    Needed: 3; Found: 0; Missing: 3; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/registrable.py"

  • No docstring for register.foo
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/tf_utils.py"

  • No module docstring
  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
    Needed: 10; Found: 7; Missing: 3; Coverage: 70.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/utils.py"

  • No module docstring
  • No docstring for softplus_inverse
  • No docstring for inv_sigmoid
    Needed: 7; Found: 4; Missing: 3; Coverage: 57.1%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/initializer.py"

  • No module docstring
  • No docstring for BoxInitializer.__call__
  • No docstring for BoxInitializer.__repr__
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/gumbel_intersection.py"

  • No module docstring
  • No docstring for _compute_logaddexp_with_clipping_and_separate_forward
  • No docstring for _compute_logaddexp_with_clipping
  • No docstring for _compute_logaddexp
    Needed: 8; Found: 4; Missing: 4; Coverage: 50.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/bag_of_boxes.py"

  • No module docstring
  • No docstring for bag_of_boxes_pooler
  • No docstring for BagOfBoxesBoxPooler.__init__
    Needed: 5; Found: 2; Missing: 3; Coverage: 40.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/intersection.py"

  • No module docstring
  • No docstring for hard_intersection_pooler
  • No docstring for HardIntersectionBoxPooler.__init__
  • No docstring for HardIntersectionBoxPooler.forward
    Needed: 5; Found: 1; Missing: 4; Coverage: 20.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/hard_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_box_tensor.py"

  • No docstring for TFBoxTensor.__repr__
  • No docstring for TFBoxTensor.args
  • No docstring for TFBoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for TFBoxFactory.__call__
    Needed: 22; Found: 17; Missing: 5; Coverage: 77.3%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/setup.py"

  • No module docstring
  • No docstring for load_requirements
    Needed: 2; Found: 0; Missing: 2; Coverage: 0.0%

Overall statistics for 20 files (1 files are empty):
Needed: 107 - Found: 70 - Missing: 37
Total coverage: 65.4% - Grade: Good

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/constant.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/uniform_boxes.py"

  • No module docstring
  • No docstring for UniformBoxInitializer.__call__
    Needed: 5; Found: 3; Missing: 2; Coverage: 60.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/box_module.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/embedding.py"

  • No module docstring
  • No docstring for BoxEmbedding.__init__
  • No docstring for BoxEmbedding.forward
  • No docstring for BoxEmbedding.all_boxes
  • No docstring for BoxEmbedding.get_bounding_box
    Needed: 6; Found: 1; Missing: 5; Coverage: 16.7%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/_intersection.py"

  • No module docstring
  • No docstring for _Intersection.forward
  • No docstring for _Intersection._forward
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/hard_intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/pooling.py"

  • No module docstring
  • No docstring for BoxPooler.forward
    Needed: 3; Found: 1; Missing: 2; Coverage: 33.3%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/l2_side_regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/bessel_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/soft_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/box_tensor.py"

  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
  • No docstring for BoxTensor.__repr__
  • No docstring for BoxTensor.__eq__
  • No docstring for BoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for BoxFactory.__call__
    Needed: 28; Found: 21; Missing: 7; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/delta_box_tensor.py"

  • No docstring for MinDeltaBoxTensor.kwargs
  • No docstring for MinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_delta_box_tensor.py"

  • No docstring for TFMinDeltaBoxTensor.kwargs
  • No docstring for TFMinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

Overall statistics for 20 files (2 files are empty):
Needed: 100 - Found: 67 - Missing: 33
Total coverage: 67.0% - Grade: Good

@trangtran72 trangtran72 linked an issue Apr 11, 2021 that may be closed by this pull request
Pytorch Docs Theme missing certain elements #43
Closed
@github-actions

This comment has been minimized.

Sign in to view
@github-actions
Copy link

Docstrings Coverage Report

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/init.py"

  • No module docstring
  • No docstring for torch_is_available
  • No docstring for tensorflow_is_available
    Needed: 3; Found: 0; Missing: 3; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/registrable.py"

  • No docstring for register.foo
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/tf_utils.py"

  • No module docstring
  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
    Needed: 10; Found: 7; Missing: 3; Coverage: 70.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/utils.py"

  • No module docstring
  • No docstring for softplus_inverse
  • No docstring for inv_sigmoid
    Needed: 7; Found: 4; Missing: 3; Coverage: 57.1%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/initializer.py"

  • No module docstring
  • No docstring for BoxInitializer.__call__
  • No docstring for BoxInitializer.__repr__
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/gumbel_intersection.py"

  • No module docstring
  • No docstring for _compute_logaddexp_with_clipping_and_separate_forward
  • No docstring for _compute_logaddexp_with_clipping
  • No docstring for _compute_logaddexp
    Needed: 8; Found: 4; Missing: 4; Coverage: 50.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/bag_of_boxes.py"

  • No module docstring
  • No docstring for bag_of_boxes_pooler
  • No docstring for BagOfBoxesBoxPooler.__init__
    Needed: 5; Found: 2; Missing: 3; Coverage: 40.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/intersection.py"

  • No module docstring
  • No docstring for hard_intersection_pooler
  • No docstring for HardIntersectionBoxPooler.__init__
  • No docstring for HardIntersectionBoxPooler.forward
    Needed: 5; Found: 1; Missing: 4; Coverage: 20.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/hard_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_box_tensor.py"

  • No docstring for TFBoxTensor.__repr__
  • No docstring for TFBoxTensor.args
  • No docstring for TFBoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for TFBoxFactory.__call__
    Needed: 22; Found: 17; Missing: 5; Coverage: 77.3%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/setup.py"

  • No module docstring
  • No docstring for load_requirements
    Needed: 2; Found: 0; Missing: 2; Coverage: 0.0%

Overall statistics for 20 files (1 files are empty):
Needed: 107 - Found: 70 - Missing: 37
Total coverage: 65.4% - Grade: Good

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/constant.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/uniform_boxes.py"

  • No module docstring
  • No docstring for UniformBoxInitializer.__call__
    Needed: 5; Found: 3; Missing: 2; Coverage: 60.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/box_module.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/embedding.py"

  • No module docstring
  • No docstring for BoxEmbedding.__init__
  • No docstring for BoxEmbedding.forward
  • No docstring for BoxEmbedding.all_boxes
  • No docstring for BoxEmbedding.get_bounding_box
    Needed: 6; Found: 1; Missing: 5; Coverage: 16.7%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/_intersection.py"

  • No module docstring
  • No docstring for _Intersection.forward
  • No docstring for _Intersection._forward
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/hard_intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/pooling.py"

  • No module docstring
  • No docstring for BoxPooler.forward
    Needed: 3; Found: 1; Missing: 2; Coverage: 33.3%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/l2_side_regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/bessel_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/soft_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/box_tensor.py"

  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
  • No docstring for BoxTensor.__repr__
  • No docstring for BoxTensor.__eq__
  • No docstring for BoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for BoxFactory.__call__
    Needed: 28; Found: 21; Missing: 7; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/delta_box_tensor.py"

  • No docstring for MinDeltaBoxTensor.kwargs
  • No docstring for MinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_delta_box_tensor.py"

  • No docstring for TFMinDeltaBoxTensor.kwargs
  • No docstring for TFMinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

Overall statistics for 20 files (2 files are empty):
Needed: 100 - Found: 67 - Missing: 33
Total coverage: 67.0% - Grade: Good

1 similar comment
@github-actions
Copy link

Docstrings Coverage Report

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/init.py"

  • No module docstring
  • No docstring for torch_is_available
  • No docstring for tensorflow_is_available
    Needed: 3; Found: 0; Missing: 3; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/registrable.py"

  • No docstring for register.foo
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/tf_utils.py"

  • No module docstring
  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
    Needed: 10; Found: 7; Missing: 3; Coverage: 70.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/utils.py"

  • No module docstring
  • No docstring for softplus_inverse
  • No docstring for inv_sigmoid
    Needed: 7; Found: 4; Missing: 3; Coverage: 57.1%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/initializer.py"

  • No module docstring
  • No docstring for BoxInitializer.__call__
  • No docstring for BoxInitializer.__repr__
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/gumbel_intersection.py"

  • No module docstring
  • No docstring for _compute_logaddexp_with_clipping_and_separate_forward
  • No docstring for _compute_logaddexp_with_clipping
  • No docstring for _compute_logaddexp
    Needed: 8; Found: 4; Missing: 4; Coverage: 50.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/bag_of_boxes.py"

  • No module docstring
  • No docstring for bag_of_boxes_pooler
  • No docstring for BagOfBoxesBoxPooler.__init__
    Needed: 5; Found: 2; Missing: 3; Coverage: 40.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/intersection.py"

  • No module docstring
  • No docstring for hard_intersection_pooler
  • No docstring for HardIntersectionBoxPooler.__init__
  • No docstring for HardIntersectionBoxPooler.forward
    Needed: 5; Found: 1; Missing: 4; Coverage: 20.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/hard_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_box_tensor.py"

  • No docstring for TFBoxTensor.__repr__
  • No docstring for TFBoxTensor.args
  • No docstring for TFBoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for TFBoxFactory.__call__
    Needed: 22; Found: 17; Missing: 5; Coverage: 77.3%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/setup.py"

  • No module docstring
  • No docstring for load_requirements
    Needed: 2; Found: 0; Missing: 2; Coverage: 0.0%

Overall statistics for 20 files (1 files are empty):
Needed: 107 - Found: 70 - Missing: 37
Total coverage: 65.4% - Grade: Good

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/constant.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/uniform_boxes.py"

  • No module docstring
  • No docstring for UniformBoxInitializer.__call__
    Needed: 5; Found: 3; Missing: 2; Coverage: 60.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/box_module.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/embedding.py"

  • No module docstring
  • No docstring for BoxEmbedding.__init__
  • No docstring for BoxEmbedding.forward
  • No docstring for BoxEmbedding.all_boxes
  • No docstring for BoxEmbedding.get_bounding_box
    Needed: 6; Found: 1; Missing: 5; Coverage: 16.7%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/_intersection.py"

  • No module docstring
  • No docstring for _Intersection.forward
  • No docstring for _Intersection._forward
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/hard_intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/pooling.py"

  • No module docstring
  • No docstring for BoxPooler.forward
    Needed: 3; Found: 1; Missing: 2; Coverage: 33.3%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/l2_side_regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/bessel_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/soft_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/box_tensor.py"

  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
  • No docstring for BoxTensor.__repr__
  • No docstring for BoxTensor.__eq__
  • No docstring for BoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for BoxFactory.__call__
    Needed: 28; Found: 21; Missing: 7; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/delta_box_tensor.py"

  • No docstring for MinDeltaBoxTensor.kwargs
  • No docstring for MinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_delta_box_tensor.py"

  • No docstring for TFMinDeltaBoxTensor.kwargs
  • No docstring for TFMinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

Overall statistics for 20 files (2 files are empty):
Needed: 100 - Found: 67 - Missing: 33
Total coverage: 67.0% - Grade: Good

@github-actions
Copy link

Docstrings Coverage Report

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/init.py"

  • No module docstring
  • No docstring for torch_is_available
  • No docstring for tensorflow_is_available
    Needed: 3; Found: 0; Missing: 3; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/registrable.py"

  • No docstring for register.foo
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/tf_utils.py"

  • No module docstring
  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
    Needed: 10; Found: 7; Missing: 3; Coverage: 70.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/utils.py"

  • No module docstring
  • No docstring for softplus_inverse
  • No docstring for inv_sigmoid
    Needed: 7; Found: 4; Missing: 3; Coverage: 57.1%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/initializer.py"

  • No module docstring
  • No docstring for BoxInitializer.__call__
  • No docstring for BoxInitializer.__repr__
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/gumbel_intersection.py"

  • No module docstring
  • No docstring for _compute_logaddexp_with_clipping_and_separate_forward
  • No docstring for _compute_logaddexp_with_clipping
  • No docstring for _compute_logaddexp
    Needed: 8; Found: 4; Missing: 4; Coverage: 50.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/bag_of_boxes.py"

  • No module docstring
  • No docstring for bag_of_boxes_pooler
  • No docstring for BagOfBoxesBoxPooler.__init__
    Needed: 5; Found: 2; Missing: 3; Coverage: 40.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/intersection.py"

  • No module docstring
  • No docstring for hard_intersection_pooler
  • No docstring for HardIntersectionBoxPooler.__init__
  • No docstring for HardIntersectionBoxPooler.forward
    Needed: 5; Found: 1; Missing: 4; Coverage: 20.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/hard_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_box_tensor.py"

  • No docstring for TFBoxTensor.__repr__
  • No docstring for TFBoxTensor.args
  • No docstring for TFBoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for TFBoxFactory.__call__
    Needed: 22; Found: 17; Missing: 5; Coverage: 77.3%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/setup.py"

  • No module docstring
  • No docstring for load_requirements
    Needed: 2; Found: 0; Missing: 2; Coverage: 0.0%

Overall statistics for 20 files (1 files are empty):
Needed: 107 - Found: 70 - Missing: 37
Total coverage: 65.4% - Grade: Good

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/constant.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/uniform_boxes.py"

  • No module docstring
  • No docstring for UniformBoxInitializer.__call__
    Needed: 5; Found: 3; Missing: 2; Coverage: 60.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/box_module.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/embedding.py"

  • No module docstring
  • No docstring for BoxEmbedding.__init__
  • No docstring for BoxEmbedding.forward
  • No docstring for BoxEmbedding.all_boxes
  • No docstring for BoxEmbedding.get_bounding_box
    Needed: 6; Found: 1; Missing: 5; Coverage: 16.7%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/_intersection.py"

  • No module docstring
  • No docstring for _Intersection.forward
  • No docstring for _Intersection._forward
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/hard_intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/pooling.py"

  • No module docstring
  • No docstring for BoxPooler.forward
    Needed: 3; Found: 1; Missing: 2; Coverage: 33.3%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/l2_side_regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/bessel_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/soft_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/box_tensor.py"

  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
  • No docstring for BoxTensor.__repr__
  • No docstring for BoxTensor.__eq__
  • No docstring for BoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for BoxFactory.__call__
    Needed: 28; Found: 21; Missing: 7; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/delta_box_tensor.py"

  • No docstring for MinDeltaBoxTensor.kwargs
  • No docstring for MinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_delta_box_tensor.py"

  • No docstring for TFMinDeltaBoxTensor.kwargs
  • No docstring for TFMinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

Overall statistics for 20 files (2 files are empty):
Needed: 100 - Found: 67 - Missing: 33
Total coverage: 67.0% - Grade: Good

@github-actions
Copy link

Docstrings Coverage Report

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/init.py"

  • No module docstring
  • No docstring for torch_is_available
  • No docstring for tensorflow_is_available
    Needed: 3; Found: 0; Missing: 3; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/registrable.py"

  • No docstring for register.foo
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/tf_utils.py"

  • No module docstring
  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
    Needed: 10; Found: 7; Missing: 3; Coverage: 70.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/utils.py"

  • No module docstring
  • No docstring for softplus_inverse
  • No docstring for inv_sigmoid
    Needed: 7; Found: 4; Missing: 3; Coverage: 57.1%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/initializer.py"

  • No module docstring
  • No docstring for BoxInitializer.__call__
  • No docstring for BoxInitializer.__repr__
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/gumbel_intersection.py"

  • No module docstring
  • No docstring for _compute_logaddexp_with_clipping_and_separate_forward
  • No docstring for _compute_logaddexp_with_clipping
  • No docstring for _compute_logaddexp
    Needed: 8; Found: 4; Missing: 4; Coverage: 50.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/bag_of_boxes.py"

  • No module docstring
  • No docstring for bag_of_boxes_pooler
  • No docstring for BagOfBoxesBoxPooler.__init__
    Needed: 5; Found: 2; Missing: 3; Coverage: 40.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/intersection.py"

  • No module docstring
  • No docstring for hard_intersection_pooler
  • No docstring for HardIntersectionBoxPooler.__init__
  • No docstring for HardIntersectionBoxPooler.forward
    Needed: 5; Found: 1; Missing: 4; Coverage: 20.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/hard_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_box_tensor.py"

  • No docstring for TFBoxTensor.__repr__
  • No docstring for TFBoxTensor.args
  • No docstring for TFBoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for TFBoxFactory.__call__
    Needed: 22; Found: 17; Missing: 5; Coverage: 77.3%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/setup.py"

  • No module docstring
  • No docstring for load_requirements
    Needed: 2; Found: 0; Missing: 2; Coverage: 0.0%

Overall statistics for 20 files (1 files are empty):
Needed: 107 - Found: 70 - Missing: 37
Total coverage: 65.4% - Grade: Good

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/constant.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/uniform_boxes.py"

  • No module docstring
  • No docstring for UniformBoxInitializer.__call__
    Needed: 5; Found: 3; Missing: 2; Coverage: 60.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/box_module.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/embedding.py"

  • No module docstring
  • No docstring for BoxEmbedding.__init__
  • No docstring for BoxEmbedding.forward
  • No docstring for BoxEmbedding.all_boxes
  • No docstring for BoxEmbedding.get_bounding_box
    Needed: 6; Found: 1; Missing: 5; Coverage: 16.7%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/_intersection.py"

  • No module docstring
  • No docstring for _Intersection.forward
  • No docstring for _Intersection._forward
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/hard_intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/pooling.py"

  • No module docstring
  • No docstring for BoxPooler.forward
    Needed: 3; Found: 1; Missing: 2; Coverage: 33.3%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/l2_side_regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/bessel_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/soft_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/box_tensor.py"

  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
  • No docstring for BoxTensor.__repr__
  • No docstring for BoxTensor.__eq__
  • No docstring for BoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for BoxFactory.__call__
    Needed: 28; Found: 21; Missing: 7; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/delta_box_tensor.py"

  • No docstring for MinDeltaBoxTensor.kwargs
  • No docstring for MinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_delta_box_tensor.py"

  • No docstring for TFMinDeltaBoxTensor.kwargs
  • No docstring for TFMinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

Overall statistics for 20 files (2 files are empty):
Needed: 100 - Found: 67 - Missing: 33
Total coverage: 67.0% - Grade: Good

@github-actions
Copy link

Docstrings Coverage Report

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/init.py"

  • No module docstring
  • No docstring for torch_is_available
  • No docstring for tensorflow_is_available
    Needed: 3; Found: 0; Missing: 3; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/registrable.py"

  • No docstring for register.foo
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/tf_utils.py"

  • No module docstring
  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
    Needed: 10; Found: 7; Missing: 3; Coverage: 70.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/utils.py"

  • No module docstring
  • No docstring for softplus_inverse
  • No docstring for inv_sigmoid
    Needed: 7; Found: 4; Missing: 3; Coverage: 57.1%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/initializer.py"

  • No module docstring
  • No docstring for BoxInitializer.__call__
  • No docstring for BoxInitializer.__repr__
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/gumbel_intersection.py"

  • No module docstring
  • No docstring for _compute_logaddexp_with_clipping_and_separate_forward
  • No docstring for _compute_logaddexp_with_clipping
  • No docstring for _compute_logaddexp
    Needed: 8; Found: 4; Missing: 4; Coverage: 50.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/bag_of_boxes.py"

  • No module docstring
  • No docstring for bag_of_boxes_pooler
  • No docstring for BagOfBoxesBoxPooler.__init__
    Needed: 5; Found: 2; Missing: 3; Coverage: 40.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/intersection.py"

  • No module docstring
  • No docstring for hard_intersection_pooler
  • No docstring for HardIntersectionBoxPooler.__init__
  • No docstring for HardIntersectionBoxPooler.forward
    Needed: 5; Found: 1; Missing: 4; Coverage: 20.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/hard_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_box_tensor.py"

  • No docstring for TFBoxTensor.__repr__
  • No docstring for TFBoxTensor.args
  • No docstring for TFBoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for TFBoxFactory.__call__
    Needed: 22; Found: 17; Missing: 5; Coverage: 77.3%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/setup.py"

  • No module docstring
  • No docstring for load_requirements
    Needed: 2; Found: 0; Missing: 2; Coverage: 0.0%

Overall statistics for 20 files (1 files are empty):
Needed: 107 - Found: 70 - Missing: 37
Total coverage: 65.4% - Grade: Good

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/constant.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/uniform_boxes.py"

  • No module docstring
  • No docstring for UniformBoxInitializer.__call__
    Needed: 5; Found: 3; Missing: 2; Coverage: 60.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/box_module.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/embedding.py"

  • No module docstring
  • No docstring for BoxEmbedding.__init__
  • No docstring for BoxEmbedding.forward
  • No docstring for BoxEmbedding.all_boxes
  • No docstring for BoxEmbedding.get_bounding_box
    Needed: 6; Found: 1; Missing: 5; Coverage: 16.7%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/_intersection.py"

  • No module docstring
  • No docstring for _Intersection.forward
  • No docstring for _Intersection._forward
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/hard_intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/pooling.py"

  • No module docstring
  • No docstring for BoxPooler.forward
    Needed: 3; Found: 1; Missing: 2; Coverage: 33.3%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/l2_side_regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/bessel_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/soft_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/box_tensor.py"

  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
  • No docstring for BoxTensor.__repr__
  • No docstring for BoxTensor.__eq__
  • No docstring for BoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for BoxFactory.__call__
    Needed: 28; Found: 21; Missing: 7; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/delta_box_tensor.py"

  • No docstring for MinDeltaBoxTensor.kwargs
  • No docstring for MinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_delta_box_tensor.py"

  • No docstring for TFMinDeltaBoxTensor.kwargs
  • No docstring for TFMinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

Overall statistics for 20 files (2 files are empty):
Needed: 100 - Found: 67 - Missing: 33
Total coverage: 67.0% - Grade: Good

1 similar comment
@github-actions
Copy link

Docstrings Coverage Report

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/init.py"

  • No module docstring
  • No docstring for torch_is_available
  • No docstring for tensorflow_is_available
    Needed: 3; Found: 0; Missing: 3; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/registrable.py"

  • No docstring for register.foo
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/tf_utils.py"

  • No module docstring
  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
    Needed: 10; Found: 7; Missing: 3; Coverage: 70.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/utils.py"

  • No module docstring
  • No docstring for softplus_inverse
  • No docstring for inv_sigmoid
    Needed: 7; Found: 4; Missing: 3; Coverage: 57.1%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/initializer.py"

  • No module docstring
  • No docstring for BoxInitializer.__call__
  • No docstring for BoxInitializer.__repr__
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/gumbel_intersection.py"

  • No module docstring
  • No docstring for _compute_logaddexp_with_clipping_and_separate_forward
  • No docstring for _compute_logaddexp_with_clipping
  • No docstring for _compute_logaddexp
    Needed: 8; Found: 4; Missing: 4; Coverage: 50.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/bag_of_boxes.py"

  • No module docstring
  • No docstring for bag_of_boxes_pooler
  • No docstring for BagOfBoxesBoxPooler.__init__
    Needed: 5; Found: 2; Missing: 3; Coverage: 40.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/intersection.py"

  • No module docstring
  • No docstring for hard_intersection_pooler
  • No docstring for HardIntersectionBoxPooler.__init__
  • No docstring for HardIntersectionBoxPooler.forward
    Needed: 5; Found: 1; Missing: 4; Coverage: 20.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/hard_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_box_tensor.py"

  • No docstring for TFBoxTensor.__repr__
  • No docstring for TFBoxTensor.args
  • No docstring for TFBoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for TFBoxFactory.__call__
    Needed: 22; Found: 17; Missing: 5; Coverage: 77.3%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/setup.py"

  • No module docstring
  • No docstring for load_requirements
    Needed: 2; Found: 0; Missing: 2; Coverage: 0.0%

Overall statistics for 20 files (1 files are empty):
Needed: 107 - Found: 70 - Missing: 37
Total coverage: 65.4% - Grade: Good

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/constant.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/uniform_boxes.py"

  • No module docstring
  • No docstring for UniformBoxInitializer.__call__
    Needed: 5; Found: 3; Missing: 2; Coverage: 60.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/box_module.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/embedding.py"

  • No module docstring
  • No docstring for BoxEmbedding.__init__
  • No docstring for BoxEmbedding.forward
  • No docstring for BoxEmbedding.all_boxes
  • No docstring for BoxEmbedding.get_bounding_box
    Needed: 6; Found: 1; Missing: 5; Coverage: 16.7%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/_intersection.py"

  • No module docstring
  • No docstring for _Intersection.forward
  • No docstring for _Intersection._forward
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/hard_intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/pooling.py"

  • No module docstring
  • No docstring for BoxPooler.forward
    Needed: 3; Found: 1; Missing: 2; Coverage: 33.3%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/l2_side_regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/bessel_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/soft_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/box_tensor.py"

  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
  • No docstring for BoxTensor.__repr__
  • No docstring for BoxTensor.__eq__
  • No docstring for BoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for BoxFactory.__call__
    Needed: 28; Found: 21; Missing: 7; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/delta_box_tensor.py"

  • No docstring for MinDeltaBoxTensor.kwargs
  • No docstring for MinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_delta_box_tensor.py"

  • No docstring for TFMinDeltaBoxTensor.kwargs
  • No docstring for TFMinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

Overall statistics for 20 files (2 files are empty):
Needed: 100 - Found: 67 - Missing: 33
Total coverage: 67.0% - Grade: Good

@github-actions
Copy link

Docstrings Coverage Report

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/init.py"

  • No module docstring
  • No docstring for torch_is_available
  • No docstring for tensorflow_is_available
    Needed: 3; Found: 0; Missing: 3; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/registrable.py"

  • No docstring for register.foo
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/tf_utils.py"

  • No module docstring
  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
    Needed: 10; Found: 7; Missing: 3; Coverage: 70.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/utils.py"

  • No module docstring
  • No docstring for softplus_inverse
  • No docstring for inv_sigmoid
    Needed: 7; Found: 4; Missing: 3; Coverage: 57.1%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/initializer.py"

  • No module docstring
  • No docstring for BoxInitializer.__call__
  • No docstring for BoxInitializer.__repr__
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/gumbel_intersection.py"

  • No module docstring
  • No docstring for _compute_logaddexp_with_clipping_and_separate_forward
  • No docstring for _compute_logaddexp_with_clipping
  • No docstring for _compute_logaddexp
    Needed: 8; Found: 4; Missing: 4; Coverage: 50.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/bag_of_boxes.py"

  • No module docstring
  • No docstring for bag_of_boxes_pooler
  • No docstring for BagOfBoxesBoxPooler.__init__
    Needed: 5; Found: 2; Missing: 3; Coverage: 40.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/intersection.py"

  • No module docstring
  • No docstring for hard_intersection_pooler
  • No docstring for HardIntersectionBoxPooler.__init__
  • No docstring for HardIntersectionBoxPooler.forward
    Needed: 5; Found: 1; Missing: 4; Coverage: 20.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/hard_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_box_tensor.py"

  • No docstring for TFBoxTensor.__repr__
  • No docstring for TFBoxTensor.args
  • No docstring for TFBoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for TFBoxFactory.__call__
    Needed: 22; Found: 17; Missing: 5; Coverage: 77.3%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/setup.py"

  • No module docstring
  • No docstring for load_requirements
    Needed: 2; Found: 0; Missing: 2; Coverage: 0.0%

Overall statistics for 20 files (1 files are empty):
Needed: 107 - Found: 70 - Missing: 37
Total coverage: 65.4% - Grade: Good

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/constant.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/uniform_boxes.py"

  • No module docstring
  • No docstring for UniformBoxInitializer.__call__
    Needed: 5; Found: 3; Missing: 2; Coverage: 60.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/box_module.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/embedding.py"

  • No module docstring
  • No docstring for BoxEmbedding.__init__
  • No docstring for BoxEmbedding.forward
  • No docstring for BoxEmbedding.all_boxes
  • No docstring for BoxEmbedding.get_bounding_box
    Needed: 6; Found: 1; Missing: 5; Coverage: 16.7%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/_intersection.py"

  • No module docstring
  • No docstring for _Intersection.forward
  • No docstring for _Intersection._forward
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/hard_intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/pooling.py"

  • No module docstring
  • No docstring for BoxPooler.forward
    Needed: 3; Found: 1; Missing: 2; Coverage: 33.3%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/l2_side_regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/bessel_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/soft_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/box_tensor.py"

  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
  • No docstring for BoxTensor.__repr__
  • No docstring for BoxTensor.__eq__
  • No docstring for BoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for BoxFactory.__call__
    Needed: 28; Found: 21; Missing: 7; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/delta_box_tensor.py"

  • No docstring for MinDeltaBoxTensor.kwargs
  • No docstring for MinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_delta_box_tensor.py"

  • No docstring for TFMinDeltaBoxTensor.kwargs
  • No docstring for TFMinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

Overall statistics for 20 files (2 files are empty):
Needed: 100 - Found: 67 - Missing: 33
Total coverage: 67.0% - Grade: Good

@github-actions
Copy link

Docstrings Coverage Report

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/init.py"

  • No module docstring
  • No docstring for torch_is_available
  • No docstring for tensorflow_is_available
    Needed: 3; Found: 0; Missing: 3; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/registrable.py"

  • No docstring for register.foo
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/tf_utils.py"

  • No module docstring
  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
    Needed: 10; Found: 7; Missing: 3; Coverage: 70.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/initializer.py"

  • No module docstring
  • No docstring for BoxInitializer.__call__
  • No docstring for BoxInitializer.__repr__
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/tf_uniform_boxes.py"

  • No module docstring
  • No docstring for TFUniformBoxInitializer.__call__
    Needed: 5; Found: 3; Missing: 2; Coverage: 60.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/gumbel_intersection.py"

  • No module docstring
  • No docstring for _compute_logaddexp_with_clipping_and_separate_forward
  • No docstring for _compute_logaddexp_with_clipping
  • No docstring for _compute_logaddexp
    Needed: 8; Found: 4; Missing: 4; Coverage: 50.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/hard_intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/intersection.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/pooling.py"

  • No module docstring
  • No docstring for BoxPooler.forward
    Needed: 3; Found: 1; Missing: 2; Coverage: 33.3%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/l2_side_regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/regularizer.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/bessel_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/hard_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/delta_box_tensor.py"

  • No docstring for MinDeltaBoxTensor.kwargs
  • No docstring for MinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_box_tensor.py"

  • No docstring for TFBoxTensor.__repr__
  • No docstring for TFBoxTensor.args
  • No docstring for TFBoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for TFBoxFactory.__call__
    Needed: 23; Found: 18; Missing: 5; Coverage: 78.3%

File: "/home/runner/work/box-embeddings/box-embeddings/setup.py"

  • No module docstring
  • No docstring for load_requirements
    Needed: 2; Found: 0; Missing: 2; Coverage: 0.0%

Overall statistics for 21 files:
Needed: 108 - Found: 71 - Missing: 37
Total coverage: 65.7% - Grade: Good

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/constant.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/common/utils.py"

  • No module docstring
  • No docstring for softplus_inverse
  • No docstring for inv_sigmoid
    Needed: 7; Found: 4; Missing: 3; Coverage: 57.1%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/tf_initializer.py"

  • No module docstring
  • No docstring for TFBoxInitializer.__call__
  • No docstring for TFBoxInitializer.__repr__
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/initializations/uniform_boxes.py"

  • No module docstring
  • No docstring for UniformBoxInitializer.__call__
    Needed: 5; Found: 3; Missing: 2; Coverage: 60.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/init.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/box_module.py"

  • File is empty
    Needed: 0; Found: 0; Missing: 0; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/embedding.py"

  • No module docstring
  • No docstring for BoxEmbedding.__init__
  • No docstring for BoxEmbedding.forward
  • No docstring for BoxEmbedding.all_boxes
  • No docstring for BoxEmbedding.get_bounding_box
    Needed: 6; Found: 1; Missing: 5; Coverage: 16.7%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/intersection/_intersection.py"

  • No module docstring
  • No docstring for _Intersection.forward
  • No docstring for _Intersection._forward
    Needed: 4; Found: 1; Missing: 3; Coverage: 25.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/bag_of_boxes.py"

  • No module docstring
  • No docstring for bag_of_boxes_pooler
  • No docstring for BagOfBoxesBoxPooler.__init__
    Needed: 5; Found: 2; Missing: 3; Coverage: 40.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/pooling/intersection.py"

  • No module docstring
  • No docstring for hard_intersection_pooler
  • No docstring for HardIntersectionBoxPooler.__init__
  • No docstring for HardIntersectionBoxPooler.forward
    Needed: 5; Found: 1; Missing: 4; Coverage: 20.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/regularization/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/init.py"

  • No module docstring
    Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/_volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/soft_volume.py"

  • No module docstring
    Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/modules/volume/volume.py"

  • No module docstring
    Needed: 4; Found: 3; Missing: 1; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/box_tensor.py"

  • No docstring for _box_shape_ok
  • No docstring for _shape_error_str
  • No docstring for BoxTensor.__repr__
  • No docstring for BoxTensor.__eq__
  • No docstring for BoxFactory.__init__
  • No docstring for register_box_class.add_box_class
  • No docstring for BoxFactory.__call__
    Needed: 28; Found: 21; Missing: 7; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_delta_box_tensor.py"

  • No docstring for TFMinDeltaBoxTensor.kwargs
  • No docstring for TFMinDeltaBoxTensor.args
    Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_sigmoid_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

File: "/home/runner/work/box-embeddings/box-embeddings/box_embeddings/parameterizations/tf_tanh_box_tensor.py"
Needed: 7; Found: 7; Missing: 0; Coverage: 100.0%

Overall statistics for 21 files (3 files are empty):
Needed: 109 - Found: 71 - Missing: 38
Total coverage: 65.1% - Grade: Good

@dhruvdcoder dhruvdcoder merged commit 162d753 into dev/main Apr 14, 2021
@dhruvdcoder dhruvdcoder deleted the dev/trang branch April 14, 2021 17:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dhruvdcoder dhruvdcoder Awaiting requested review from dhruvdcoder

@mboratko mboratko Awaiting requested review from mboratko

@ssdasgupta ssdasgupta Awaiting requested review from ssdasgupta

Assignees

@trangtran72 trangtran72

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Usage Documentation Pytorch Docs Theme missing certain elements Put example usage into docstrings
3 participants
@trangtran72 @codecov-io @dhruvdcoder