🎨 Fix formatting

src/hebg/__init__.py

@@ -1,7 +1,7 @@
 # HEBGraph for explainable hierarchical reinforcement learning
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 
-""" A structure for explainable hierarchical reinforcement learning """
+"""A structure for explainable hierarchical reinforcement learning"""
 
 from hebg.behavior import Behavior
 from hebg.heb_graph import HEBGraph

src/hebg/behavior.py

@@ -1,7 +1,7 @@
 # HEBGraph for explainable hierarchical reinforcement learning
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 
-""" Module for base Behavior. """
+"""Module for base Behavior."""
 
 from __future__ import annotations
 
@@ -15,7 +15,6 @@
 
 
 class Behavior(Node):
-
     """Abstract class for a Behavior as Node"""
 
     def __init__(self, name: str, image=None) -> None:

src/hebg/graph.py

@@ -2,7 +2,7 @@
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 # pylint: disable=protected-access
 
-""" Additional utility functions for networkx graphs. """
+"""Additional utility functions for networkx graphs."""
 
 from typing import TYPE_CHECKING, Any, Dict, List
 

src/hebg/heb_graph.py

@@ -2,7 +2,7 @@
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 # pylint: disable=arguments-differ
 
-""" Module containing the HEBGraph base class. """
+"""Module containing the HEBGraph base class."""
 
 from __future__ import annotations
 
@@ -24,7 +24,6 @@
 
 
 class HEBGraph(DiGraph):
-
     """Base class for Hierchical Explanation of Behavior as Graphs.
 
     An HEBGraph is a DiGraph, and as such stores nodes and directed edges with

src/hebg/layouts/__init__.py

@@ -1,7 +1,7 @@
 # HEBGraph for explainable hierarchical reinforcement learning
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 
-""" Module containing layouts to draw graphs. """
+"""Module containing layouts to draw graphs."""
 
 from hebg.layouts.deterministic import staircase_layout
 from hebg.layouts.metabased import leveled_layout_energy

src/hebg/layouts/deterministic.py

@@ -2,7 +2,7 @@
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 # pylint: disable=protected-access
 
-""" Deterministic layouts """
+"""Deterministic layouts"""
 
 import networkx as nx
 import numpy as np

src/hebg/layouts/metabased.py

@@ -2,7 +2,7 @@
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 # pylint: disable=protected-access
 
-""" Metaheuristics based layouts """
+"""Metaheuristics based layouts"""
 
 from copy import deepcopy
 

src/hebg/layouts/metaheuristics.py

@@ -1,7 +1,7 @@
 # HEBGraph for explainable hierarchical reinforcement learning
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 
-""" Metaheuristics used for building layouts """
+"""Metaheuristics used for building layouts"""
 
 import numpy as np
 

src/hebg/metrics/__init__.py

@@ -1,4 +1,4 @@
 # HEBGraph for explainable hierarchical reinforcement learning
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 
-""" Module containing HEBGraph metrics. """
+"""Module containing HEBGraph metrics."""

src/hebg/metrics/complexity/__init__.py

@@ -1,7 +1,7 @@
 # HEBGraph for explainable hierarchical reinforcement learning
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 
-""" Module for complexity computation methods. """
+"""Module for complexity computation methods."""
 
 from hebg.metrics.complexity.complexities import general_complexity, learning_complexity
 

src/hebg/metrics/complexity/complexities.py

@@ -1,8 +1,7 @@
 # HEBGraph for explainable hierarchical reinforcement learning
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 
-""" General complexity. """
-
+"""General complexity."""
 
 from typing import TYPE_CHECKING, Dict, Tuple
 

src/hebg/metrics/complexity/utils.py

@@ -1,7 +1,7 @@
 # HEBGraph for explainable hierarchical reinforcement learning
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 
-""" Utility functions for complexity computation. """
+"""Utility functions for complexity computation."""
 
 from copy import deepcopy
 

src/hebg/metrics/histograms.py

@@ -1,7 +1,7 @@
 # HEBGraph for explainable hierarchical reinforcement learning
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 
-""" HEBGraph used nodes histograms computation. """
+"""HEBGraph used nodes histograms computation."""
 
 from typing import TYPE_CHECKING, Dict, List, Tuple
 from warnings import warn

src/hebg/metrics/utility/__init__.py

@@ -1,7 +1,7 @@
 # HEBGraph for explainable hierarchical reinforcement learning
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 
-""" Module for utility computation methods. """
+"""Module for utility computation methods."""
 
 from hebg.metrics.utility.binary_utility import binary_graphbased_utility
 

src/hebg/metrics/utility/binary_utility.py

@@ -1,7 +1,7 @@
 # HEBGraph for explainable hierarchical reinforcement learning
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 
-""" Simplest binary utility for HEBGraph. """
+"""Simplest binary utility for HEBGraph."""
 
 from typing import Dict, List
 

src/hebg/node.py

@@ -1,7 +1,7 @@
 # HEBGraph for explainable hierarchical reinforcement learning
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 
-""" Module for base Node classes. """
+"""Module for base Node classes."""
 
 import dis
 from typing import Any, List
@@ -68,7 +68,6 @@ def __repr__(self) -> str:
 
 
 class Action(Node):
-
     """Node representing an action in an HEBGraph."""
 
     def __init__(self, action: Any, name: str = None, **kwargs) -> None:
@@ -84,7 +83,6 @@ def __call__(self, observation: Any) -> Any:
 
 
 class StochasticAction(Action):
-
     """Node representing a stochastic choice between actions in an HEBGraph."""
 
     def __init__(
@@ -99,7 +97,6 @@ def __call__(self, observation):
 
 
 class FeatureCondition(Node):
-
     """Node representing a feature condition in an HEBGraph."""
 
     def __init__(self, name: str = None, **kwargs) -> None:
@@ -110,7 +107,6 @@ def __call__(self, observation: Any) -> int:
 
 
 class EmptyNode(Node):
-
     """Node representing an empty node in an HEBGraph."""
 
     def __init__(self, name: str) -> None:

src/hebg/requirements_graph.py

@@ -2,7 +2,7 @@
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 # pylint: disable=arguments-differ
 
-""" Module for building underlying requirement graphs based on a set of behaviors. """
+"""Module for building underlying requirement graphs based on a set of behaviors."""
 
 from __future__ import annotations
 

src/hebg/unrolling.py

@@ -4,6 +4,7 @@
 Behaviors that do not have a graph (Unexplainable behaviors) should stay as is in the graph.
 
 """
+
 from copy import copy
 from typing import TYPE_CHECKING, Dict, List, Tuple, Optional, Union
 

tests/__init__.py

@@ -1,4 +1,4 @@
 # HEBGraph for explainable hierarchical reinforcement learning
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 
-""" Tests for the heb_graph package. """
+"""Tests for the heb_graph package."""

tests/examples/behaviors/basic.py

@@ -8,7 +8,6 @@
 
 
 class FundamentalBehavior(Behavior):
-
     """Fundamental behavior based on an Action."""
 
     def __init__(self, action: Action) -> None:
@@ -23,7 +22,6 @@ def build_graph(self) -> HEBGraph:
 
 
 class AA_Behavior(Behavior):
-
     """Double root fundamental behavior"""
 
     def __init__(self, name: str, any_mode: str) -> None:
@@ -40,7 +38,6 @@ def build_graph(self) -> HEBGraph:
 
 
 class F_A_Behavior(Behavior):
-
     """Single feature condition behavior"""
 
     def __init__(
@@ -68,7 +65,6 @@ def build_graph(self) -> HEBGraph:
 
 
 class F_F_A_Behavior(Behavior):
-
     """Double layer feature conditions behavior"""
 
     def build_graph(self) -> HEBGraph:
@@ -91,7 +87,6 @@ def build_graph(self) -> HEBGraph:
 
 
 class F_AA_Behavior(Behavior):
-
     """Feature condition with mutliple actions on same index."""
 
     def __init__(self, name: str, any_mode: str) -> None:
@@ -110,7 +105,6 @@ def build_graph(self) -> HEBGraph:
 
 
 class AF_A_Behavior(Behavior):
-
     """Double root with feature condition and action"""
 
     def __init__(self, name: str, any_mode: str) -> None:

tests/examples/behaviors/basic_empty.py

@@ -6,7 +6,6 @@
 
 
 class E_A_Behavior(Behavior):
-
     """Empty behavior"""
 
     def __init__(self, name: str, action: Action) -> None:
@@ -20,7 +19,6 @@ def build_graph(self) -> HEBGraph:
 
 
 class E_F_A_Behavior(Behavior):
-
     """Double layer empty then feature conditions behavior"""
 
     def build_graph(self) -> HEBGraph:
@@ -37,7 +35,6 @@ def build_graph(self) -> HEBGraph:
 
 
 class F_E_A_Behavior(Behavior):
-
     """Double layer feature conditions then empty behavior"""
 
     def build_graph(self) -> HEBGraph:
@@ -57,7 +54,6 @@ def build_graph(self) -> HEBGraph:
 
 
 class E_E_A_Behavior(Behavior):
-
     """Double layer empty behavior"""
 
     def build_graph(self) -> HEBGraph:

tests/examples/behaviors/binary_sum.py

@@ -1,4 +1,4 @@
-from hebg import Action, Behavior
+from hebg import Action
 from tests.examples.behaviors import F_A_Behavior
 from tests.examples.feature_conditions import IsDivisibleFeatureCondition
 

tests/examples/feature_conditions/__init__.py

@@ -2,3 +2,6 @@
     ThresholdFeatureCondition,
     IsDivisibleFeatureCondition,
 )
+
+
+__all__ = ["ThresholdFeatureCondition", "IsDivisibleFeatureCondition"]

tests/integration/__init__.py

@@ -1,4 +1,4 @@
 # HEBGraph for explainable hierarchical reinforcement learning
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 
-""" Integration tests for the heb_graph package. """
+"""Integration tests for the heb_graph package."""

tests/integration/test_behavior.py

@@ -1,7 +1,7 @@
 # HEBGraph for explainable hierarchical reinforcement learning
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 
-""" Behavior of HEBGraphs when called. """
+"""Behavior of HEBGraphs when called."""
 
 import pytest_check as check
 

tests/integration/test_behavior_empty.py

@@ -1,7 +1,7 @@
 # HEBGraph for explainable hierarchical reinforcement learning
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 
-""" Behavior of HEBGraphs with empty nodes. """
+"""Behavior of HEBGraphs with empty nodes."""
 
 import pytest_check as check
 
@@ -12,7 +12,6 @@
     F_E_A_Behavior,
     E_E_A_Behavior,
 )
-from tests.examples.feature_conditions import ThresholdFeatureCondition
 
 
 def test_e_a_graph():

tests/integration/test_paper_basic_example.py

@@ -1,7 +1,7 @@
 # HEBGraph for explainable hierarchical reinforcement learning
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 
-""" Integration tests for the initial paper examples. """
+"""Integration tests for the initial paper examples."""
 
 from typing import Dict, List
 from copy import deepcopy

tests/unit/__init__.py

@@ -1,4 +1,4 @@
 # HEBGraph for explainable hierarchical reinforcement learning
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 
-""" Unit tests for the heb_graph package. """
+"""Unit tests for the heb_graph package."""

tests/unit/layouts/__init__.py

@@ -1,4 +1,4 @@
 # HEBGraph for explainable hierarchical reinforcement learning
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 
-""" Unit tests for the hebg.layouts submodules. """
+"""Unit tests for the hebg.layouts submodules."""

tests/unit/layouts/test_metaheuristics.py

@@ -1,7 +1,7 @@
 # HEBGraph for explainable hierarchical reinforcement learning
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 
-""" Unit tests for the hebg.metaheuristics module. """
+"""Unit tests for the hebg.metaheuristics module."""
 
 import numpy as np
 

tests/unit/metrics/__init__.py

@@ -1,4 +1,4 @@
 # HEBGraph for explainable hierarchical reinforcement learning
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 
-""" Unit tests for the hebg.metrics module. """
+"""Unit tests for the hebg.metrics module."""

tests/unit/metrics/complexity/__init__.py

@@ -1,4 +1,4 @@
 # HEBGraph for explainable hierarchical reinforcement learning
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 
-""" Unit tests for the hebg.metrics.complexity module. """
+"""Unit tests for the hebg.metrics.complexity module."""

tests/unit/metrics/complexity/test_complexities.py

@@ -1,13 +1,9 @@
 # HEBGraph for explainable hierarchical reinforcement learning
 # Copyright (C) 2021-2022 Mathïs FEDERICO <https://www.gnu.org/licenses/>
 
-""" Integration tests for the hebg.metrics.complexity.complexities module. """
+"""Integration tests for the hebg.metrics.complexity.complexities module."""
 
 import pytest
-import pytest_check as check
-
-from hebg.metrics.complexity.complexities import learning_complexity
-from hebg import Action, Behavior, FeatureCondition
 
 
 class TestComplexities: