[Global] Cleaned code

CHANGELOG.rst

@@ -2,7 +2,7 @@
 Changelog
 =========
 
-Version 0.1
+Version 0.1.4
 ===========
 
 - Feature A added

README.md

@@ -17,7 +17,7 @@ SKit is an innovative Python library that simplifies the deployment process of M
 You can install SKit using pip:
 
 ```
-pip install SKit
+pip install git+https://github.com/YanSteph/SKit.git
 ```
 
 ## Usage
@@ -34,7 +34,7 @@ The complete documentation for SKit will come soon.
 
 ## Contributing
 
-Contributions are always welcome! 
+Contributions are always welcome!
 
 ## License
 

src/skit/dataset.py

@@ -225,12 +225,16 @@ def tf_shuffle_dataset(dataset, batch_size, seed):
         Shuffles a TensorFlow dataset memory-preservingly using a batch-based method and also shuffles the batches themselves.
 
         Args:
-        - dataset (tf.data.Dataset): The input dataset to shuffle.
-        - batch_size (int): Size of each batch.
-        - seed (int, optional): Seed for shuffle reproducibility.
+        - dataset :tf.data.Dataset
+            The input dataset to shuffle.
+        - batch_size : int
+            Size of each batch.
+        - seed : int, optional
+            Seed for shuffle reproducibility.
 
         Returns:
-        - tf.data.Dataset: Shuffled dataset.
+        - tf.data.Dataset:
+            Shuffled dataset.
 
         Example:
         --------

src/skit/main.py

@@ -1,12 +1,8 @@
-
-
-
 # ---- Gobal import ----
 
 import skit.config as config
 from skit.ModelMetrics import ModelMetrics
 
-# TODO
 import argparse
 import logging
 import sys
@@ -19,53 +15,19 @@
 
 _logger = logging.getLogger(__name__)
 
-
-# ---- Python API ----
-# The functions defined in this section can be imported by users in their
-# Python scripts/interactive interpreter, e.g. via
-# `from skit.skeleton import fib`,
-# when using this Python module as a library.
-
-
-def fib(n):
-    """Fibonacci example function
-
-    Args:
-      n (int): integer
-
-    Returns:
-      int: n-th Fibonacci number
-    """
-    assert n > 0
-    a, b = 1, 1
-    for _i in range(n - 1):
-        a, b = b, a + b
-    return a
-
-
 # ---- CLI ----
 # The functions defined in this section are wrappers around the main Python
 # API allowing them to be called directly from the terminal as a CLI
 # executable/script.
 
 
 def parse_args(args):
-    """Parse command line parameters
-
-    Args:
-      args (List[str]): command line parameters as list of strings
-          (for example  ``["--help"]``).
-
-    Returns:
-      :obj:`argparse.Namespace`: command line parameters namespace
-    """
-    parser = argparse.ArgumentParser(description="Just a Fibonacci demonstration")
+    parser = argparse.ArgumentParser(description="This step is in progress")
     parser.add_argument(
         "--version",
         action="version",
         version=f"skit {__version__}",
     )
-    parser.add_argument(dest="n", help="n-th Fibonacci number", type=int, metavar="INT")
     parser.add_argument(
         "-v",
         "--verbose",
@@ -98,20 +60,8 @@ def setup_logging(loglevel):
 
 
 def main(args):
-    """Wrapper allowing :func:`fib` to be called with string arguments in a CLI fashion
-
-    Instead of returning the value from :func:`fib`, it prints the result to the
-    ``stdout`` in a nicely formatted message.
-
-    Args:
-      args (List[str]): command line parameters as list of strings
-          (for example  ``["--verbose", "42"]``).
-    """
     args = parse_args(args)
     setup_logging(args.loglevel)
-    _logger.debug("Starting crazy calculations...")
-    print(f"The {args.n}-th Fibonacci number is {fib(args.n)}")
-    _logger.info("Script ends here")
 
 
 def run():