Merge pull request #19 from siddhantpathakk/development

Added new docs and __init__ files

Author: Siddhant Pathak

.DS_Store

@@ -0,0 +1,15 @@
+## About the author
+
+Hey, I'm Siddhant!
+
+![1691398779159](image/author/1691398779159.png)
+
+I’m a Final Year Computer Science student at Nanyang Technological University, Singapore. 
+
+I’m currently learning Machine Learning, Data Science and Artificial Intelligence for Finance and Scalable Applications.
+
+I am an individual driven by an unwavering motivation and a relentless ambition to excel in every endeavor I undertake. Throughout my personal and academic journey, I have cultivated a profound sense of responsibility and a decisive mindset, enabling me to effectively tackle any situation that comes my way. Whether it's confronting complex challenges or embracing new opportunities, I consistently strive to deliver exceptional results.
+
+Currently, I am pursuing my studies in the field of Computer Science at a renowned university, renowned for its excellence in education and diverse student body. Being part of such an esteemed institution has provided me with invaluable exposure to a vibrant peer group, comprising individuals from various backgrounds and cultures. This exposure has further enhanced my understanding of the significance of teamwork and cultural integration. I firmly believe that diverse perspectives foster innovation and collaboration, and I actively seek to create an inclusive environment where every voice is heard and valued.
+
+Check my portfolio out [here](siddhantpathakk.github.io) and also my [GitHub](https://github.com/siddhantpathakk). Connect with me on [Linkedin](https://www.linkedin.com/in/siddhantpathakk/), [email](mailto:siddhant005@e.ntu.edu.sg).

docs/author.md

@@ -1,27 +1,27 @@
 # Classification
 
-::: classification.naive_bayes.gaussian
+## ::: classification.naive_bayes.gaussian
     handler: python
     options:
         show_root_heading: true
         show_source: false
         heading_level: 2
----------------------------------------
-::: classification.naive_bayes.bernoulli
+
+## ::: classification.naive_bayes.bernoulli
     handler: python
     options:
         show_root_heading: true
         show_source: false
         heading_level: 2
----------------------------------------
-::: classification.logistic_regression
+
+## ::: classification.logistic_regression
     handler: python
     options:
         show_root_heading: true
         show_source: false
         heading_level: 2
----------------------------------------
-:::classification.decision_tree
+
+## :::classification.decision_tree
     handler: python
     options:
         show_root_heading: true

docs/class.md

@@ -1,17 +1,28 @@
 site_name: Tensorflow ML
+repo_url: https://github.com/siddhantpathakk/tensorflow-ml
 
 nav:
   - Home: index.md
   - Support: status.md
   - Regression : reg.md
   - Classification : class.md
   - Tutorials: tutorials.md
-  - About: about.md
+  - About the package: about.md
+  - About the author: author.md
 
-theme: readthedocs
+theme:
+  name: readthedocs
+  analytics:
+    gtag: G-ABC123
+  titles-only: True
+  navigation_depth: 2
 
-plugins: 
+
+plugins:
   - mkdocstrings:
       handlers:
         python:
-          paths: [tensorflow_ml]  # search packages in the src folder
+          paths: [tensorflow_ml]  # search packages in the src folder
+          docstring_section_style: "spacy"
+  - search:
+      indexing: 'sections'

docs/image/author/1691398779159.png

@@ -1 +1,26 @@
 # __init__ file for tfml package
+
+from .regression import (
+    LinearRegression,
+    LassoRegression,
+    PolynomialRegression,
+    RidgeRegression
+)
+
+from .classification import (
+    DecisionTree,
+    LogisticRegression,
+    BernoulliNaiveBayes,
+    GaussianNaiveBayes
+)
+
+__all__ = [
+    "LinearRegression",
+    "LassoRegression",
+    "PolynomialRegression",
+    "RidgeRegression",
+    "DecisionTree",
+    "LogisticRegression",
+    "BernoulliNaiveBayes",
+    "GaussianNaiveBayes"
+]

mkdocs.yml

@@ -0,0 +1,17 @@
+"""
+Classification module
+"""
+
+from .decision_tree import DecisionTree
+from .logistic_regression import LogisticRegression
+from .naive_bayes import (
+    BernoulliNaiveBayes,
+    GaussianNaiveBayes
+)
+
+__all__ = [
+    "DecisionTree",
+    "LogisticRegression",
+    "BernoulliNaiveBayes",
+    "GaussianNaiveBayes"
+]