ChaterJee 0.2.6__py3-none-any.whl → 0.2.7__py3-none-any.whl

{chaterjee-0.2.6.dist-info → chaterjee-0.2.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ChaterJee
-Version: 0.2.6
+Version: 0.2.7
 Summary: Communicate your project updates via Telegram Bot!
 Author: Pallab Dutta
 Author-email: pallab9997@gmail.com
@@ -19,7 +19,13 @@ These are probably the most boring, time-consuming, yet unavoidable phases in ou
 Let me introduce ChaterJee to you — a playful fusion of `Chater`, meaning one who chats, and `Jee`, an honorific used in Indian culture to show respect. Think of `ChaterJee` as the lab assistant you always wanted — one who actually responds, never crashes your code, doesn't ask for co-authorship, and definitely doesn't need coffee all the time, unlike you.
 
 # Installation
-You need two things:
+As a prerequisite you are required to install the `jq` library for reading JSON files from bash script. 
+```bash
+sudo apt update
+sudo apt install jq
+```
+
+Now, you need two things:
  1. The `ChaterJee` module
  2. A telegram BOT that you own
 
@@ -60,27 +66,79 @@ https://api.telegram.org/bot123456789:ABCdefGhiJKlmNoPQRsTuvWXyz/getUpdates
  - `ChatLogs` class: This reads log files, the last line is sent to you via the BOT. It can also share you final plots that you need for your next rerun.
 
 ## The minimal example
-This will register your JOB with the given `JOB_NAME` and logfiles into a JSON file, `<your home>/.data/JOB_status.json`.
+This will register your JOB with the given `JOBNAME` and logfiles into a JSON file, `<your home>/.data/JOB_status.json`.
 
+`script.py`
 ```python
 # This is a minimal example
+
+# Your imports
+from pathlib import Path
 import ChaterJee
+import json
 
 # your code here
-JOB_NAME = "job_0.1.10"
-OUT_NAME = "experiment_0.1"
-
-for i in range(N):
-    # Your code here
-    notelogs = ChaterJee.NoteLogs()
-    notelogs.write(f"{JOB_NAME}",\
-    logSTRING=f"Step {i} done.",\
-    logFILE=f"{OUT_NAME}.log",\
-    logIMAGE=f"{OUT_NAME}.png")
- ```
+with open("hyperparams.json","r") as ffr:
+    HYPERPARAMS = json.load(ffr)
+    # get your parameters
+    JOBNAME = HYPERPARAMS["JOBNAME"]
+    LOGDIR = HYPERPARAMS["LOGDIR"]
+    LOGFILE = HYPERPARAMS["LOGFILE"]
+    LOGIMAGE = HYPERPARAMS["LOGIMAGE"]
+
+notelogs = ChaterJee.NoteLogs()
+notelogs.write(
+    jobNAME=JOBNAME,
+    logDIR=LOGDIR,
+    logFILE=LOGFILE,
+    logIMAGE=LOGIMAGE
+    )
+
+### Your code that generates logs
+print(f"{logs}")
+
+### Your code that generates plot
+logPath = Path(LOGDIR)
+plt.savefig(logPath / LOGIMAGE)
+```
+
+The `hyperparams.json` file should look like the following. It must contain the last 4 `{key: value}` pairs to let our BOT access the log results.
+
+`hyperparams.json`
+```json
+{
+    .
+    .
+
+    "JOBNAME": "model_2.4",
+    "LOGDIR": "./run_2.4",
+    "LOGFILE": "outFile.log",
+    "LOGIMAGE": "outImage.png"
+}
+```
+Save the following script in your working directory to rerun your tuning experiments quickly. 
+
+`run.sh`
+```bash
+#!/bin/bash
+
+# Path to hyperparameter file
+hyparam_file="hyperparams.json"
+
+# Read values from config.json using jq
+stdout_log=$(jq -r '.LOGFILE' "$hyparam_file")
+stdout_dir=$(jq -r '.LOGDIR' "$hyparam_file")
+
+# Create log directory
+mkdir -p "$stdout_dir"
+
+# Run the Python script with redirected logs
+nohup python script.py --hyprm "$hyparam_file" > "$stdout_dir/$stdout_log" 2> "$stdout_dir/error.log" &
+```
 
 Next step is to receive updates on your projects. 
 
+`updater.py`
 ```python
 # Run this instance separately to parse job updates
 # This is the one which actually communicates with your BOT.
@@ -94,3 +152,15 @@ if __name__ == '__main__':
     cbot = ChaterJee.ChatLogs(TOKEN, CHATID)
     cbot.cmdTRIGGER()
 ```
+Run the above script in a separate terminal session to start interacting with your BOT.
+
+## At your Telegram App
+- Think your inbox as the terminal.
+- `cd`, `ls` etc. works as expected. Therefore to go to parent directory, you simply type: `cd ..` , and to list contents type `ls` . You can run the `run.sh` executable just by typing `./run.sh` .
+- texts starting with `/` are telegram-BOT commands.
+
+At this stage the following 4 commands work:
+- `/start` : Starts the conversation with the BOT.
+- `/jobs` : List the jobs as Keyboard button options.
+- `/clear` : Clears the chat history once you allow.
+- `/edit file.json` : Let you edit and save the JSON file by the webapp Editor Babu. 

chaterjee-0.2.7.dist-info/RECORD

@@ -0,0 +1,6 @@
+ChaterJee/ChaterJee.py,sha256=oTSXbCSpfXB8f9m7ErXSFMlgGayGifI8FUHRa2DeFDg,12995
+ChaterJee/__init__.py,sha256=tZmkZY2XbzJ8rHDh8nOmb1W73kPecPv3xcEiCPwkZf4,98
+chaterjee-0.2.7.dist-info/METADATA,sha256=AlMpY3NNrzmlfUx5_1DfvBCAWxb4vA_l9e1bIECrtOw,5872
+chaterjee-0.2.7.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
+chaterjee-0.2.7.dist-info/top_level.txt,sha256=Z1UAYoaNybpDiKjqa1yFpti_q0FNECVItb3-9yAh3gM,10
+chaterjee-0.2.7.dist-info/RECORD,,

chaterjee-0.2.6.dist-info/RECORD

@@ -1,6 +0,0 @@
-ChaterJee/ChaterJee.py,sha256=oTSXbCSpfXB8f9m7ErXSFMlgGayGifI8FUHRa2DeFDg,12995
-ChaterJee/__init__.py,sha256=tZmkZY2XbzJ8rHDh8nOmb1W73kPecPv3xcEiCPwkZf4,98
-chaterjee-0.2.6.dist-info/METADATA,sha256=4vxE7azdZinkvyeVseBAvFDyBvRib3Sei7UfYqYZzPA,3844
-chaterjee-0.2.6.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
-chaterjee-0.2.6.dist-info/top_level.txt,sha256=Z1UAYoaNybpDiKjqa1yFpti_q0FNECVItb3-9yAh3gM,10
-chaterjee-0.2.6.dist-info/RECORD,,