epignatelli / navix

Accelerated minigrid environments with JAX
Apache License 2.0
103 stars 7 forks source link

Env names #83

Closed epignatelli closed 2 months ago

github-actions[bot] commented 2 months ago
************* Module navix._version
navix/_version.py:1:0: C0114: Missing module docstring (missing-module-docstring)
************* Module navix.environments.crossings
navix/environments/crossings.py:1:0: C0114: Missing module docstring (missing-module-docstring)
navix/environments/crossings.py:38:0: C0115: Missing class docstring (missing-class-docstring)
navix/environments/crossings.py:42:4: R0914: Too many local variables (24/15) (too-many-locals)
navix/environments/crossings.py:105:12: W0612: Unused variable 'i' (unused-variable)
navix/environments/crossings.py:106:16: W0612: Unused variable 'k3' (unused-variable)

Report
======
51 statements analysed.

Statistics by type
------------------

+---------+-------+-----------+-----------+------------+---------+
|type     |number |old number |difference |%documented |%badname |
+=========+=======+===========+===========+============+=========+
|module   |2      |NC         |NC         |0.00        |0.00     |
+---------+-------+-----------+-----------+------------+---------+
|class    |1      |NC         |NC         |0.00        |0.00     |
+---------+-------+-----------+-----------+------------+---------+
|method   |1      |NC         |NC         |100.00      |0.00     |
+---------+-------+-----------+-----------+------------+---------+
|function |1      |NC         |NC         |100.00      |0.00     |
+---------+-------+-----------+-----------+------------+---------+

External dependencies
---------------------
::

    navix 
      \-components (navix.environments.crossings)
      \-entities (navix.environments.crossings)
      \-observations (navix.environments.crossings)
      \-rendering 
      | \-cache (navix.environments.crossings)
      \-rewards (navix.environments.crossings)
      \-states (navix.environments.crossings)
      \-terminations (navix.environments.crossings)

205 lines have been analyzed

Raw metrics
-----------

+----------+-------+------+---------+-----------+
|type      |number |%     |previous |difference |
+==========+=======+======+=========+===========+
|code      |136    |66.34 |NC       |NC         |
+----------+-------+------+---------+-----------+
|docstring |6      |2.93  |NC       |NC         |
+----------+-------+------+---------+-----------+
|comment   |35     |17.07 |NC       |NC         |
+----------+-------+------+---------+-----------+
|empty     |28     |13.66 |NC       |NC         |
+----------+-------+------+---------+-----------+

Duplication
-----------

+-------------------------+------+---------+-----------+
|                         |now   |previous |difference |
+=========================+======+=========+===========+
|nb duplicated lines      |0     |NC       |NC         |
+-------------------------+------+---------+-----------+
|percent duplicated lines |0.000 |NC       |NC         |
+-------------------------+------+---------+-----------+

Messages by category
--------------------

+-----------+-------+---------+-----------+
|type       |number |previous |difference |
+===========+=======+=========+===========+
|convention |3      |NC       |NC         |
+-----------+-------+---------+-----------+
|refactor   |1      |NC       |NC         |
+-----------+-------+---------+-----------+
|warning    |2      |NC       |NC         |
+-----------+-------+---------+-----------+
|error      |0      |NC       |NC         |
+-----------+-------+---------+-----------+

% errors / warnings by module
-----------------------------

+-----------------------------+------+--------+---------+-----------+
|module                       |error |warning |refactor |convention |
+=============================+======+========+=========+===========+
|navix.environments.crossings |0.00  |100.00  |100.00   |66.67      |
+-----------------------------+------+--------+---------+-----------+
|navix._version               |0.00  |0.00    |0.00     |33.33      |
+-----------------------------+------+--------+---------+-----------+

Messages
--------

+-------------------------+------------+
|message id               |occurrences |
+=========================+============+
|unused-variable          |2           |
+-------------------------+------------+
|missing-module-docstring |2           |
+-------------------------+------------+
|too-many-locals          |1           |
+-------------------------+------------+
|missing-class-docstring  |1           |
+-------------------------+------------+

-----------------------------------
Your code has been rated at 8.82/10