Update documentation

Author: pockerman

docs/source/API/parallel/process_manager.rst

@@ -0,0 +1,7 @@
+processes\_manager
+==================
+
+.. automodule:: processes_manager
+
+.. autoclass:: TorchProcsHandler
+   :members: __init__, __len__, create_and_start, create_process_and_start, join, terminate, join_and_terminate

docs/source/API/preprocessor/preprocess_utils.rst

@@ -0,0 +1,5 @@
+preprocess\_utils
+=================
+
+.. automodule:: preprocess_utils
+   :members: read_csv, replace, change_column_types

docs/source/conf.py

@@ -18,6 +18,8 @@
 sys.path.append(os.path.abspath("../../src/exceptions/"))
 sys.path.append(os.path.abspath("../../src/spaces/"))
 sys.path.append(os.path.abspath("../../src/policies/"))
+sys.path.append(os.path.abspath("../../src/parallel/"))
+sys.path.append(os.path.abspath("../../src/preprocessor/"))
 sys.path.append(os.path.abspath("../../src/maths/"))
 sys.path.append(os.path.abspath("../../src/utils/"))
 sys.path.append(os.path.abspath("../../src/datasets/"))

docs/source/modules.rst

@@ -21,7 +21,9 @@ API
    API/maths/pytorch_optimizer_config
    API/maths/string_distance_calculator
    API/networks/a2c_networks
+   API/parallel/process_manager
    API/policies/epsilon_greedy_policy
+   API/preprocessor/preprocess_utils
    API/spaces/actions
    API/spaces/action_space
    API/spaces/state

src/apps/compare_dataset.py

@@ -2,7 +2,7 @@
 
 from src.datasets.datasets_loaders import MockSubjectsLoader
 from src.datasets.dataset_wrapper import PandasDSWrapper
-from src.preprocessor.cleanup_utils import replace, change_column_types
+from src.preprocessor.preprocess_utils import replace, change_column_types
 from src.maths.numeric_distance_type import NumericDistanceType
 from src.maths.string_distance_calculator import StringDistanceType
 from src.maths.distortion_calculator import DistortionCalculationType, DistortionCalculator

src/datasets/dataset_wrapper.py

@@ -1,10 +1,15 @@
+"""module dataset_wrapper. Utilities
+to wrap a DataFrame so that it can be uses
+as an environment suitable for RL algorithms
+
+"""
 from pathlib import Path
 import abc
 from typing import Generic, TypeVar
 import pandas as pd
 import numpy as np
 
-from src.preprocessor.cleanup_utils import read_csv, replace, change_column_types
+from src.preprocessor.preprocess_utils import read_csv, replace, change_column_types
 from src.exceptions.exceptions import InvalidDataTypeException
 
 DS = TypeVar("DS")
@@ -13,6 +18,9 @@
 
 
 class DSWrapper(Generic[DS], metaclass=abc.ABCMeta):
+    """Base class for deriving data set wrappers
+
+    """
 
     def __init__(self) -> None:
         super(DSWrapper, self).__init__()
@@ -29,8 +37,7 @@ def read(self, filename: Path, **options) -> None:
 
 
 class PandasDSWrapper(DSWrapper[pd.DataFrame]):
-    """
-    Simple wrapper to a pandas DataFrame object.
+    """Simple wrapper to a pandas DataFrame object.
     Facilitates various actions on the original dataset
     """
 

src/maths/numeric_distance_calculator.py

@@ -1,4 +1,4 @@
-"""Various methods to calculate distance between numeric vectors
+"""module numeric_distance_calculator. Various methods to calculate distance between numeric vectors
 """
 import numpy as np
 from typing import TypeVar

src/parallel/processes_manager.py

@@ -1,3 +1,7 @@
+"""module process_manager. Utilities for managing
+processes
+
+"""
 from typing import Callable
 
 import torch.multiprocessing as mp

src/preprocessor/cleanup_utils.py src/preprocessor/preprocess_utils.pysrc/preprocessor/cleanup_utils.py renamed to src/preprocessor/preprocess_utils.py

@@ -1,18 +1,31 @@
+"""module preprocess_utils. Specifies utilities for
+preprocessing a data set.
+
+"""
 import csv
 import pandas as pd
 from pathlib import Path
 from typing import List
 
 
-def read_csv(filename: Path, features_drop_names: List[str], names: List[str], delimiter=','):
-    """
-    Read the csv file specified at the given filename
-    :param filename: The path to the filw to read
-    :param features_drop_names: Features to drop
-    :param names: Names of columns
-    :return:
+def read_csv(filename: Path, features_drop_names: List[str], names: List[str], delimiter=',') -> pd.DataFrame:
+
+    """Read the csv file specified at the given filename
+
+    Parameters
+    ----------
+    filename: Filename to read
+    features_drop_names: Which columns to drop
+    names: Column names
+    delimiter: file delimiter
+
+    Returns
+    -------
+
+    A pandas DataFrame
     """
 
+
     df = pd.read_csv(filepath_or_buffer=filename, sep=delimiter, header=0, names=names)
 
     if len(features_drop_names) != 0:
@@ -25,14 +38,20 @@ def read_csv(filename: Path, features_drop_names: List[str], names: List[str], d
 
 
 def replace(ds: pd.DataFrame, options: dict) -> pd.DataFrame:
-    """
-    Replace the values in the given data set according to the passed
+    """Replace the values in the given data set according to the passed
     options. The options should specify for each column the values
     to be changed and the corresponding values to set
-    :param ds: The dataframe to replace
-    :param options:
-    :return: None
+
+    Parameters
+    ----------
+    ds
+    options
+
+    Returns
+    -------
+
     """
+
     for col in options:
 
         # get the values to change for each column
@@ -49,5 +68,16 @@ def replace(ds: pd.DataFrame, options: dict) -> pd.DataFrame:
 
 
 def change_column_types(ds, column_types) -> pd.DataFrame:
+    """Change the column type
+
+    Parameters
+    ----------
+    ds
+    column_types
+
+    Returns
+    -------
+
+    """
     ds = ds.astype(dtype=column_types)
     return ds

tests/test_preprocessor.py

@@ -3,7 +3,7 @@
 import pytest
 from pathlib import Path
 import pandas as pd
-from src.preprocessor.cleanup_utils import read_csv, replace, change_column_types
+from src.preprocessor.preprocess_utils import read_csv, replace, change_column_types
 
 
 class TestPreprocessor(unittest.TestCase):