Usage docs and style fixes

[codecov-io]

Codecov Report

:exclamation: No coverage uploaded for pull request base (dev/main@30275b5). Click here to learn what that means. The diff coverage is n/a.

:exclamation: Current head f12e728 differs from pull request most recent head 0520c20. Consider uploading reports for the commit 0520c20 to get more accurate results

@@             Coverage Diff             @@
##             dev/main      #31   +/-   ##
===========================================
  Coverage            ?   82.12%           
===========================================
  Files               ?       39           
  Lines               ?     1175           
  Branches            ?        0           
===========================================
  Hits                ?      965           
  Misses              ?      210           
  Partials            ?        0           

Flag	Coverage Δ
cpu	82.12% <0.00%> (?)
pytest	82.12% <0.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 30275b5...0520c20. Read the comment docs.

[trangtran72]

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[bot]]

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/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/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/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/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/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/volume/soft_volume.py"

• No module docstring Needed: 6; Found: 5; Missing: 1; Coverage: 83.3%

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

• No module docstring
• No docstring for log_hard_volume Needed: 8; Found: 6; Missing: 2; 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: 27; Found: 20; Missing: 7; Coverage: 74.1%

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 17 files (3 files are empty): Needed: 74 - Found: 42 - Missing: 32 Total coverage: 56.8% - Grade: Not bad

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/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/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/embedding.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/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/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/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/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/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/bessel_volume.py"

• No module docstring Needed: 6; Found: 5; Missing: 1; Coverage: 83.3%

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/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 _box_shape_ok
• No docstring for _shape_error_str
• No docstring for TFBoxTensor.__repr__
• No docstring for TFBoxTensor.reinit
• 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: 25; Found: 17; Missing: 8; Coverage: 68.0%

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

• No docstring for _box_shape_ok
• No docstring for softplus_inverse
• No docstring for TFMinDeltaBoxTensor.kwargs
• No docstring for TFMinDeltaBoxTensor.args Needed: 11; Found: 7; Missing: 4; Coverage: 63.6%

Overall statistics for 17 files (1 files are empty): Needed: 102 - Found: 69 - Missing: 33 Total coverage: 67.6% - Grade: Good

[github-actions[bot]]

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/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/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/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/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/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/volume/soft_volume.py"

• No module docstring Needed: 6; Found: 5; Missing: 1; Coverage: 83.3%

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

• No module docstring
• No docstring for log_hard_volume Needed: 8; Found: 6; Missing: 2; 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: 27; Found: 20; Missing: 7; Coverage: 74.1%

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 17 files (3 files are empty): Needed: 74 - Found: 42 - Missing: 32 Total coverage: 56.8% - Grade: Not bad

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/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/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/embedding.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/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/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/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/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/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/bessel_volume.py"

• No module docstring Needed: 6; Found: 5; Missing: 1; Coverage: 83.3%

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/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 _box_shape_ok
• No docstring for _shape_error_str
• No docstring for TFBoxTensor.__repr__
• No docstring for TFBoxTensor.reinit
• 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: 25; Found: 17; Missing: 8; Coverage: 68.0%

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

• No docstring for _box_shape_ok
• No docstring for softplus_inverse
• No docstring for TFMinDeltaBoxTensor.kwargs
• No docstring for TFMinDeltaBoxTensor.args Needed: 11; Found: 7; Missing: 4; Coverage: 63.6%

Overall statistics for 17 files (1 files are empty): Needed: 102 - Found: 69 - Missing: 33 Total coverage: 67.6% - Grade: Good

[github-actions[bot]]

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/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/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/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/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/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/volume/soft_volume.py"

• No module docstring Needed: 6; Found: 5; Missing: 1; Coverage: 83.3%

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

• No module docstring
• No docstring for log_hard_volume Needed: 8; Found: 6; Missing: 2; 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/setup.py"

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

Overall statistics for 17 files (3 files are empty): Needed: 75 - Found: 43 - Missing: 32 Total coverage: 57.3% - Grade: Not bad

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/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/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/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/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/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/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/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/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/bessel_volume.py"

• No module docstring Needed: 6; Found: 5; Missing: 1; Coverage: 83.3%

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/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 _box_shape_ok
• No docstring for _shape_error_str
• No docstring for TFBoxTensor.__repr__
• No docstring for TFBoxTensor.reinit
• 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: 25; Found: 17; Missing: 8; Coverage: 68.0%

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

• No docstring for _box_shape_ok
• No docstring for softplus_inverse
• No docstring for TFMinDeltaBoxTensor.kwargs
• No docstring for TFMinDeltaBoxTensor.args Needed: 11; Found: 7; Missing: 4; Coverage: 63.6%

Overall statistics for 17 files: Needed: 108 - Found: 70 - Missing: 38 Total coverage: 64.8% - Grade: Good

[github-actions[bot]]

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/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/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/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/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/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/volume/soft_volume.py"

• No module docstring Needed: 6; Found: 5; Missing: 1; Coverage: 83.3%

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

• No module docstring
• No docstring for log_hard_volume Needed: 8; Found: 6; Missing: 2; 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/setup.py"

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

Overall statistics for 17 files (3 files are empty): Needed: 75 - Found: 43 - Missing: 32 Total coverage: 57.3% - Grade: Not bad

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/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/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/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/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/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/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/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/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/bessel_volume.py"

• No module docstring Needed: 6; Found: 5; Missing: 1; Coverage: 83.3%

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/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 _box_shape_ok
• No docstring for _shape_error_str
• No docstring for TFBoxTensor.__repr__
• No docstring for TFBoxTensor.reinit
• 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: 25; Found: 17; Missing: 8; Coverage: 68.0%

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

• No docstring for _box_shape_ok
• No docstring for softplus_inverse
• No docstring for TFMinDeltaBoxTensor.kwargs
• No docstring for TFMinDeltaBoxTensor.args Needed: 11; Found: 7; Missing: 4; Coverage: 63.6%

Overall statistics for 17 files: Needed: 108 - Found: 70 - Missing: 38 Total coverage: 64.8% - Grade: Good

[github-actions[bot]]

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/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/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/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/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/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/volume/soft_volume.py"

• No module docstring Needed: 6; Found: 5; Missing: 1; Coverage: 83.3%

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

• No module docstring
• No docstring for log_hard_volume Needed: 8; Found: 6; Missing: 2; 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/setup.py"

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

Overall statistics for 17 files (3 files are empty): Needed: 75 - Found: 43 - Missing: 32 Total coverage: 57.3% - Grade: Not bad

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/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/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/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/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/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/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/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/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/bessel_volume.py"

• No module docstring Needed: 6; Found: 5; Missing: 1; Coverage: 83.3%

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/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 _box_shape_ok
• No docstring for _shape_error_str
• No docstring for TFBoxTensor.__repr__
• No docstring for TFBoxTensor.reinit
• 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: 25; Found: 17; Missing: 8; Coverage: 68.0%

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

• No docstring for _box_shape_ok
• No docstring for softplus_inverse
• No docstring for TFMinDeltaBoxTensor.kwargs
• No docstring for TFMinDeltaBoxTensor.args Needed: 11; Found: 7; Missing: 4; Coverage: 63.6%

Overall statistics for 17 files: Needed: 108 - Found: 70 - Missing: 38 Total coverage: 64.8% - Grade: Good

[github-actions[bot]]

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/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/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/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/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/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/volume/soft_volume.py"

• No module docstring Needed: 6; Found: 5; Missing: 1; Coverage: 83.3%

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

• No module docstring Needed: 8; Found: 7; Missing: 1; Coverage: 87.5%

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/setup.py"

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

Overall statistics for 17 files (3 files are empty): Needed: 75 - Found: 44 - Missing: 31 Total coverage: 58.7% - Grade: Not bad

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/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/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/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/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/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/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/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/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/bessel_volume.py"

• No module docstring Needed: 6; Found: 5; Missing: 1; Coverage: 83.3%

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/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 _box_shape_ok
• No docstring for _shape_error_str
• No docstring for TFBoxTensor.__repr__
• No docstring for TFBoxTensor.reinit
• 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: 25; Found: 17; Missing: 8; Coverage: 68.0%

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

• No docstring for _box_shape_ok
• No docstring for softplus_inverse
• No docstring for TFMinDeltaBoxTensor.kwargs
• No docstring for TFMinDeltaBoxTensor.args Needed: 11; Found: 7; Missing: 4; Coverage: 63.6%

Overall statistics for 17 files: Needed: 108 - Found: 70 - Missing: 38 Total coverage: 64.8% - Grade: Good

[github-actions[bot]]

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/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/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/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/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
• 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/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/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/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/volume/soft_volume.py"

• No module docstring Needed: 6; Found: 5; Missing: 1; Coverage: 83.3%

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_box_tensor.py"

• No docstring for TFBoxTensor.__repr__
• No docstring for TFBoxTensor.reinit
• 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: 16; Missing: 6; Coverage: 72.7%

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 19 files (2 files are empty): Needed: 111 - Found: 69 - Missing: 42 Total coverage: 62.2% - 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/tf_utils.py"

• No module docstring
• No docstring for softplus_inverse
• No docstring for inv_sigmoid
• No docstring for _box_shape_ok
• No docstring for _shape_error_str Needed: 10; Found: 5; Missing: 5; Coverage: 50.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/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/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/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/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/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/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/bessel_volume.py"

• No module docstring Needed: 6; Found: 5; Missing: 1; Coverage: 83.3%

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

• No module docstring Needed: 8; Found: 7; Missing: 1; Coverage: 87.5%

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_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/setup.py"

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

Overall statistics for 18 files (1 files are empty): Needed: 90 - Found: 62 - Missing: 28 Total coverage: 68.9% - Grade: Good

[github-actions[bot]]

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 softplus_inverse
• No docstring for inv_sigmoid
• No docstring for _box_shape_ok
• No docstring for _shape_error_str Needed: 10; Found: 5; Missing: 5; Coverage: 50.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.reinit
• 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: 16; Missing: 6; Coverage: 72.7%

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: 67 - Missing: 40 Total coverage: 62.6% - 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[bot]]

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[bot]]

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[bot]]

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[bot]]

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[bot]]

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[bot]]

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[bot]]

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[bot]]

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[bot]]

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[bot]]

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[bot]]

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[bot]]

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[bot]]

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[bot]]

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[bot]]

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[bot]]

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