Merge pull request #16 from siddhantpathakk/development

Siddhant Pathak · web-flow · commit 9f415c934636 · 2023-08-07T07:56:18.000+08:00
Development
diff --git a/.DS_Store b/.DS_Store
diff --git a/docs/about.md b/docs/about.md
@@ -0,0 +1,11 @@
+## About the package
+
+The TensorFlow ML project is useful for several reasons and can overcome the needs of scikit-learn in various scenarios:
+
+1. **TensorFlow Backend:** By leveraging TensorFlow as its backend, TensorFlow ML can take advantage of its efficient computation and optimization capabilities. TensorFlow is well-known for its ability to work with large-scale datasets and efficiently utilize hardware accelerators like GPUs and TPUs, making it suitable for handling complex machine learning models and tasks.
+2. **Flexibility and Customizability:** With TensorFlow ML, users have the flexibility to customize and fine-tune machine learning models according to their specific needs. TensorFlow's symbolic representation and automatic differentiation capabilities enable easy modification of models, loss functions, and optimization algorithms. This level of customization may not always be readily available in pre-implemented models of scikit-learn.
+3. **Continuous Development and Updates:** As TensorFlow ML is an open-source project, it can benefit from a large community of contributors and developers. This means that the project is continually evolving, and new algorithms and improvements can be added regularly. This is especially advantageous for staying up-to-date with the latest advancements in machine learning.
+4. **Unified Framework:** By using TensorFlow ML, developers and researchers can work within a single framework for both traditional machine learning and deep learning tasks. This avoids the need to switch between different libraries and provides a more cohesive environment for developing and deploying machine learning models.
+5. **Community and Support:** TensorFlow has a large and active community of users and contributors. This means that users of TensorFlow ML can benefit from the collective knowledge and support of this community, which can be invaluable for troubleshooting, sharing best practices, and fostering collaborative development.
+
+In summary, TensorFlow ML is a powerful and versatile alternative to scikit-learn, providing users with a wide range of machine learning algorithms, seamless deep learning integration, customizability, and access to the rich TensorFlow ecosystem. Whether it's traditional machine learning or cutting-edge deep learning, TensorFlow ML has the potential to meet the diverse needs of machine learning practitioners and researchers.
diff --git a/docs/class.md b/docs/class.md
@@ -0,0 +1,29 @@
+# Classification
+
+::: classification.naive_bayes.gaussian
+    handler: python
+    options:
+        show_root_heading: true
+        show_source: false
+        heading_level: 2
+---------------------------------------
+::: classification.naive_bayes.bernoulli
+    handler: python
+    options:
+        show_root_heading: true
+        show_source: false
+        heading_level: 2
+---------------------------------------
+::: classification.logistic_regression
+    handler: python
+    options:
+        show_root_heading: true
+        show_source: false
+        heading_level: 2
+---------------------------------------
+:::classification.decision_tree
+    handler: python
+    options:
+        show_root_heading: true
+        show_source: false
+        heading_level: 2
diff --git a/docs/index.md b/docs/index.md
@@ -1,17 +1,31 @@
-# Welcome to MkDocs
+# Tensorflow ML
 
-For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+TensorFlow ML is a project that aims to provide an abstract implementation of commonly used machine learning algorithms using TensorFlow, without relying on external libraries like scikit-learn. This project is designed to offer a comprehensive and flexible set of machine learning models that can be used for various tasks, such as classification, regression, clustering, and more.
 
-## Commands
+## Getting started
 
-* `mkdocs new [dir-name]` - Create a new project.
-* `mkdocs serve` - Start the live-reloading docs server.
-* `mkdocs build` - Build the documentation site.
-* `mkdocs -h` - Print help message and exit.
+You can install TensorFlow ML from PyPI using `pip`. Follow these steps:
 
-## Project layout
+```bash
+pip install tensorflow-ml
+```
 
-    mkdocs.yml    # The configuration file.
-    docs/
-        index.md  # The documentation homepage.
-        ...       # Other markdown pages, images and other files.
+Alternatively, to use TensorFlow ML from GitHub directly, follow these steps:
+
+1. Clone the GitHub repository: `git clone https://github.com/siddhantpathakk/tensorflow-ml.git`
+2. Install the required dependencies by running: `pip install -r requirements.txt`
+
+After the installation is complete, you can import the implemented machine learning models in your Python scripts and start using TensorFlow ML for your machine learning tasks.
+
+## Participate in Contributing
+
+We welcome contributions from the open-source community to enhance the TensorFlow ML library. If you are interested in contributing, follow these steps:
+
+1. Fork the project on GitHub: [https://github.com/siddhantpathakk/tensorflow-ml](https://github.com/your_username/tensorflow-ml)
+2. Create a new branch for your feature/bugfix: `git checkout -b feature-name`
+3. Implement your changes and improvements.
+4. Write tests to ensure the functionality of the added models.
+5. Commit your changes and push them to your forked repository.
+6. Create a pull request to the main repository, describing your changes in detail.
+
+Your contributions will be reviewed, and once approved, they will be merged into the main project. Let's work together to make TensorFlow ML a powerful and versatile machine learning library!
diff --git a/docs/reg.md b/docs/reg.md
@@ -0,0 +1,29 @@
+# Regression
+
+::: regression.linear
+    handler: python
+    options:
+        show_root_heading: true
+        show_source: false
+        heading_level: 2
+---------------------------------------
+::: regression.lasso
+    handler: python
+    options:
+        show_root_heading: true
+        show_source: false
+        heading_level: 2
+---------------------------------------
+::: regression.ridge
+    handler: python
+    options:
+        show_root_heading: true
+        show_source: false
+        heading_level: 2
+---------------------------------------
+::: regression.polynomial
+    handler: python
+    options:
+        show_root_heading: true
+        show_source: false
+        heading_level: 2
diff --git a/docs/status.md b/docs/status.md
@@ -0,0 +1,21 @@
+## Status
+
+This project is currently under development. The following table shows the status of the implemented machine learning models:
+
+| Model                  | Type           | Code | Test |
+| ---------------------- | -------------- | ---- | ---- |
+| Linear Regression      | Regression     | Done | Pass |
+| Logistic Regression    | Classification | Done | Pass |
+| NB - GNB/BNB           | Classification | Done | Pass |
+| Random Forest/GBT/CART | Classification | Done | Pass |
+| Lasso Regression       | Regression     | Done | Pass |
+| Polynomial Reg         | Regression     | Done | Pass |
+| Ridge Regression      | Regression     | Done | Pass |
+
+The following table shows the status of working status on different operating systems:
+
+| Operating System | Status      |
+| ---------------- | ----------- |
+| Linux            | Pass        |
+| MacOS            | In Progress |
+| Windows          | TBC         |
diff --git a/docs/tutorials.md b/docs/tutorials.md
@@ -0,0 +1,95 @@
+## Tutorials
+
+Here are some examples of how to use TensorFlow ML to create machine learning models:
+
+**REGRESSION:**
+
+* Linear Regression (Regular, Polynomial, Ridge, Lasso)
+
+```python
+from tensorflow_ml.regression.linear import LinearRegression
+
+# Try other regression models if you feel like!
+# from tensorflow_ml.regression.polynomial import PolynomialRegression
+# from tensorflow_ml.regression.ridge import RidgeRegression
+# from tensorflow_ml.regression.lasso import LassoRegression
+
+lr = LinearRegression()
+
+# Set the hyper-parameters such as learning-rate, number of epochs etc
+lr.set_params(_params)
+
+# Train the model
+lr.fit(x, y)
+
+# Get the MSE
+lr.evaluate(x, y)
+
+# Get the predictions
+lr.predict(x)
+
+# Get the R-squared value 
+lr.score(x, y)
+
+# Get the coefficients of the trained model
+lr.get_coeff()
+```
+
+**CLASSIFICATION:**
+
+* Logistic Regression
+
+```python
+from tensorflow_ml.classification.logistic_regression import LogisticRegression
+logistic_regression = LogisticRegression()
+
+# Set the hyper-parameters such as learning-rate, number of epochs etc
+logistic_regression.set_params(params)
+
+# Train the model
+logistic_regression.fit(X_train, y_train, random_seed=42, X_val=X_val, y_val=y_val)
+
+# Evaluate the model on the test set
+accuracy, cross_entropy_loss = logistic_regression.score(X_test, y_test)
+```
+
+* Naive Bayes Classifier (Bernoulli NB, Gaussian NB)
+
+```python
+from tensorflow_ml.classification.naive_bayes.bernoulli import BernoulliNaiveBayes
+
+# Set some additional hyper-parameters
+bnb = BernoulliNaiveBayes(smoothing=1.0)  # Set the desired smoothing parameter
+
+# Train the model
+bnb.fit(training_features, training_labels)
+
+# Get the accuracy of the model on test set
+accuracy = bnb.evaluate(testing_features, testing_labels)
+```
+
+* Random Forests, Gradient Boosted Trees
+
+```python
+from tensorflow_ml.classification.decision_tree import DecisionTree
+
+model = DecisionTree(model = "gbt", verbose = True) # Also can use 'rf' for Random Forests, 'cart' for Classification and Regression Tree
+
+# If regression:
+model = DecisionTree(model = "gbt", verbose = True, _task = 'regression') 
+
+# Get the parameters pre-defined by the model
+model.get_params()
+
+# Load the dataset and convert it to TFDS
+model.load_dataset(data, label)
+
+# Train the model
+model.fit(_metrics = ['mse', 'accuracy'])
+
+# Evaluate the model and view metrics and loss
+model.evaluate()
+
+# Make predictions on test/train split of data
+model.predict(length=5, split="test")
+```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1 +1,17 @@
-site_name: My Docs
+site_name: Tensorflow ML
+
+nav:
+  - Home: index.md
+  - Support: status.md
+  - Regression : reg.md
+  - Classification : class.md
+  - Tutorials: tutorials.md
+  - About: about.md
+
+theme: readthedocs
+
+plugins: 
+  - mkdocstrings:
+      handlers:
+        python:
+          paths: [tensorflow_ml]  # search packages in the src folder
