fix: updated docstrings

STOUT/predictor_demo.py

@@ -17,7 +17,9 @@
 file_out.close()
 
 # STOUT - SMILES to IUPAC names example
-file_smiles = open("test_data/SMILES_test.txt", "r")  # file is available in the Github repository
+file_smiles = open(
+    "test_data/SMILES_test.txt", "r"
+)  # file is available in the Github repository
 file_out = open("IUPAC_predictions", "w")
 
 for i, line in enumerate(file_smiles):

STOUT/repack/transformer_model_4_repack.py

@@ -2,6 +2,7 @@
 import numpy as np
 from typing import Tuple, Optional
 
+
 def get_angles(pos: int, i: int, d_model: int) -> np.ndarray:
     """
     Computes the angles for the positional encoding.
@@ -44,7 +45,9 @@ def positional_encoding(position: int, d_model: int) -> tf.Tensor:
     return tf.cast(pos_encoding, dtype=tf.float32)
 
 
-def scaled_dot_product_attention(q: tf.Tensor, k: tf.Tensor, v: tf.Tensor, mask: Optional[tf.Tensor] = None) -> Tuple[tf.Tensor, tf.Tensor]:
+def scaled_dot_product_attention(
+    q: tf.Tensor, k: tf.Tensor, v: tf.Tensor, mask: Optional[tf.Tensor] = None
+) -> Tuple[tf.Tensor, tf.Tensor]:
     """
     Calculate the attention weights.
     q, k, v must have matching leading dimensions.

STOUT/stout.py

@@ -73,8 +73,8 @@ def load_reverse_translation_utils() -> tuple:
     """
     Loads necessary utilities for reverse translation from pickle files.
 
-    This function loads the input and target tokenizers as well as the 
-    maximum length setting for input sequences. The tokenizers are loaded 
+    This function loads the input and target tokenizers as well as the
+    maximum length setting for input sequences. The tokenizers are loaded
     from pickle files located in the 'assets' directory under the default path.
 
     Returns:

docs/conf.py

@@ -12,13 +12,13 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'STOUT - Smiles-TO-iUpac-Translator'
+project = "STOUT - Smiles-TO-iUpac-Translator"
 version = STOUT.__version__
 current_year = datetime.today().year
 copyright = "2021-{}, Kohulan Rajan at the Friedrich Schiller University Jena".format(
     current_year
 )
-author = 'Kohulan Rajan'
+author = "Kohulan Rajan"
 rst_prolog = """
 .. |current_year| replace:: {}
 """.format(
@@ -37,8 +37,8 @@
     "sphinx.ext.viewcode",
 ]
 
-templates_path = ['_templates']
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 source_suffix = ".rst"
 
 # The master toctree document.
@@ -55,7 +55,7 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'alabaster'
+html_theme = "alabaster"
 
 html_theme_options = {
     "light_css_variables": {
@@ -83,6 +83,6 @@
     "top_of_page_button": "edit",
 }
 
-html_static_path = ['_static']
+html_static_path = ["_static"]
 html_favicon = "_static/STOUT.svg"
-html_logo = "_static/STOUT.png"
+html_logo = "_static/STOUT.png"