Add README.md

This commit is contained in:
Alauddin Maulana Hirzan 2024-05-11 05:25:03 +07:00
parent 2f6ea35c49
commit d3ced1e5aa
Signed by: maulanahirzan
GPG key ID: 484DAC952787FA13
2 changed files with 27 additions and 0 deletions

14
Benchmark/README.md Normal file
View file

@ -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**

13
PickleCompress/README.md Normal file
View file

@ -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