From 40213ac9237e28a575883c98b406f926899a4819 Mon Sep 17 00:00:00 2001
From: beyzayukseel <68306258+beyzayukseel@users.noreply.github.com>
Date: Wed, 24 Jan 2024 21:48:49 +0300
Subject: [PATCH] docs: add readme

---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b1bef38
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# FastAPI - fastML
+
+That repository contains an API to send request our Random Forest Classification algorithm.
+
+FastAPI is a modern, fast, web framework for building APIs with Python 3.7+ based on standard Python type hints. It is designed to be easy to use and to enable the development of high-performance APIs quickly.
+
+<br>
+
+##### USED LIBRARIES:
+<br>
+
+```
+    FastAPI
+    BaseModel
+    pickle
+    pandas
+    sklearn
+```
+
+
+
+##### PICKLE:
+
+The `pickle` module is frequently used to package (serialize) and store machine learning models in Python.
+  
+``` 
+import pickle
+with open('random-forest.pkl', 'wb') as file:
+    pickle.dump(rfc, file)
+```
+
+
+##### RUN COMMANDS:
+
+```
+python -m venv fastml
+source fastml/bin/activate (mac) or  .\fastml\Scripts\activate (windows)
+pip install uvicorn gunicorn fastapi pydantic sklearn pandas
+uvicorn random-classifier-api:app --reload
+```
+
+
+