Added a SETUP.md guide for adjustable settings as well as fixes for test settings.

Author: TavariAgent

SETUP.md

@@ -0,0 +1,48 @@
+# Setting Up the Environment
+
+---
+
+To set up the environment for TokenGate, follow the steps below:
+
+1. Clone or download the repository to your local machine.
+2. Ensure you have Python 3.12 installed on your system. 
+
+*Check your Python version by running:*
+
+```
+python --version
+```
+3. Create a virtual environment to manage dependencies. *(required)*
+4. Run the following command to install the required dependencies:
+```
+pip install -r requirements.txt
+```
+5. Once the dependencies are installed determine valid defaults for your system:
+```python
+class OperationsCoordinator: # Under this class are where you find configurations for-
+    def __init__( # controlling the workers per-core and parallel executors.
+            self, 
+            workers_per_core: int = 4, # Controls number of workers and may notgo under 2 workers.
+            enable_convergence: bool = True, # Controls dynamic worker counts.
+            convergence_verbose: bool = False,
+            base_memory_budget_mb: int = 45, # This is a control for operation memory (adjustable).
+            num_executors: int = 8, # This controls number of parallel executors.
+            auto_block_dangerous: bool = False, # Blocks explosive tasks with possibly dangerous inputs.
+    ): 
+```
+
+6.  *Even when using the runner ensure you can handle the concurrent writes, tests are currently limited to 25*.
+
+```
+- SLOW (10 writes)
+- MODERATE (25 writes)
+- FAST (50 writes) Note: Storage must fall within your system's capabilities.
+- INSANE (70 writes) <- CAUTION
+```
+
+7. Try the runner from a directory above the project root.
+```
+python -m your_project_root.demo.runner
+```
+
+8. Read the proofs for setting up your own tasks and to learn more about the system.

demo/gui_pressure_demo.py

@@ -49,7 +49,7 @@ def cpu_heavy(size: int):
 
 @task_token_guard(
     operation_type='append_log',
-    tags={'weight': 'heavy', 'storage_speed': 'FAST'},
+    tags={'weight': 'heavy', 'storage_speed': 'MODERATE'},
 )
 def append_log(path: str, message: str):
     os.makedirs(os.path.dirname(path), exist_ok=True)

demo/io_ops.py

@@ -3,7 +3,7 @@
 from ..token_system import task_token_guard
 
 
-@task_token_guard(operation_type='write_json_fast', tags={'weight': 'light', 'storage_speed': 'fast'})
+@task_token_guard(operation_type='write_json_fast', tags={'weight': 'light', 'storage_speed': 'MODERATE'})
 def write_json_fast(path, payload):
     os.makedirs(os.path.dirname(path), exist_ok=True)
     with open(path, "w", encoding="utf-8") as f:
@@ -15,7 +15,7 @@ def write_json_fast(path, payload):
     }
 
 
-@task_token_guard(operation_type='append_log_slow', tags={'weight': 'heavy', 'storage_speed': 'fast'})
+@task_token_guard(operation_type='append_log_slow', tags={'weight': 'heavy', 'storage_speed': 'MODERATE'})
 def append_log_slow(path, message):
     os.makedirs(os.path.dirname(path), exist_ok=True)
     with open(path, "a", encoding="utf-8") as f:
@@ -26,7 +26,7 @@ def append_log_slow(path, message):
     }
 
 
-@task_token_guard(operation_type='write_blob_moderate', tags={'weight': 'medium', 'storage_speed': 'fast'})
+@task_token_guard(operation_type='write_blob_moderate', tags={'weight': 'medium', 'storage_speed': 'MODERATE'})
 def write_blob_moderate(path, size_kb):
     os.makedirs(os.path.dirname(path), exist_ok=True)
     blob = b"x" * (size_kb * 1024)