From d3ced1e5aaabe7291500920574f245165dcbb7fb Mon Sep 17 00:00:00 2001
From: Alauddin Maulana Hirzan <maulanahirzan@gmail.com>
Date: Sat, 11 May 2024 05:25:03 +0700
Subject: [PATCH] Add README.md

---
 Benchmark/README.md      | 14 ++++++++++++++
 PickleCompress/README.md | 13 +++++++++++++
 2 files changed, 27 insertions(+)
 create mode 100644 Benchmark/README.md
 create mode 100644 PickleCompress/README.md

diff --git a/Benchmark/README.md b/Benchmark/README.md
new file mode 100644
index 0000000..36600d7
--- /dev/null
+++ b/Benchmark/README.md
@@ -0,0 +1,14 @@
+# Benchmarking Class
+
+This file contains Benchmarking class used to obtain process performance such as **CPU Percent**, **Memory Usages**, and **Processing Time**.
+
+## Avaiable Methods
+* __init__() : automatically obtain your PID and intialize Process vars
+* get_cpu_percent() : return **CPU Usage** in percent
+* get_memory_text_usage() : return **Memory Usage** for **text** in MB
+* get_memory_data_usage() : return **Memory Usage** for **data** in MB
+* get_memory_rss_usage() : return **Memory Usage** for **Resident Set Size** in MB
+* get_memory_vms_usage() : return **Memory Usage** for **Virtual Memory Size** in MB
+* set_start_time() : set **start time**
+* set_end_time() : set **end time**
+* get_processing_time() : get subtraction from **end time** and **start time**
diff --git a/PickleCompress/README.md b/PickleCompress/README.md
new file mode 100644
index 0000000..caff68f
--- /dev/null
+++ b/PickleCompress/README.md
@@ -0,0 +1,13 @@
+# Compress Pickle Class
+
+This file contains **Variable Dumping** with **Compression** feature.
+
+## Avaiable Methods
+* compress_pickle(filename, object, compression_mode) : Dump and Compress on-the-fly Variable using avaiable compression algorithm
+* decompress_pickle(filename) : Load dumped variables from a file
+
+## Avaiable Algorithm
+* **gz** as **gzip** in script
+* **bz2** as **bzip2** in script
+* **lzma** as **lzma** in script
+* DEFAULT **none** to dump as normal pickle