Spaces:
Paused
Paused
docs: improve README with usage instructions
Browse files- README.md +10 -7
- requirements.txt +1 -1
README.md
CHANGED
|
@@ -13,16 +13,19 @@ short_description: Negative feedback loop homeostasis simulation
|
|
| 13 |
|
| 14 |
# ⚖️ Feedback Loop Homeostasis
|
| 15 |
|
| 16 |
-
Simulate a
|
| 17 |
|
| 18 |
-
##
|
| 19 |
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
|
|
|
|
| 23 |
|
| 24 |
## How It Works
|
| 25 |
|
| 26 |
-
The
|
| 27 |
|
| 28 |
-
|
|
|
|
|
|
|
|
|
| 13 |
|
| 14 |
# ⚖️ Feedback Loop Homeostasis
|
| 15 |
|
| 16 |
+
Simulate a negative feedback loop driving a value toward a setpoint -- like a thermostat, blood sugar regulation, or any biological homeostasis mechanism.
|
| 17 |
|
| 18 |
+
## What to Try
|
| 19 |
|
| 20 |
+
1. Select a preset from the **Preset** dropdown (e.g. "Temperature control" or "Underdamped oscillation") and click **Run Simulation** to see the value converge toward the setpoint over time.
|
| 21 |
+
2. Increase the **Gain** slider to see faster convergence, or push it too high to trigger oscillation. Raise **Damping** to suppress overshoot.
|
| 22 |
+
3. Set a **Disturbance step** and **Disturbance magnitude** to inject a sudden perturbation mid-simulation and watch the loop reject it.
|
| 23 |
+
4. Compare "Overdamped" vs. "Underdamped" presets to see the tradeoff between speed and stability.
|
| 24 |
|
| 25 |
## How It Works
|
| 26 |
|
| 27 |
+
The NegativeFeedbackLoop computes a correction at each step based on the error (distance from setpoint), scaled by gain and damped to prevent oscillation. This mirrors how biological systems maintain homeostasis -- applying proportional corrections that self-regulate toward equilibrium.
|
| 28 |
|
| 29 |
+
## Learn More
|
| 30 |
+
|
| 31 |
+
[GitHub](https://github.com/coredipper/operon) | [PyPI](https://pypi.org/project/operon-ai/) | [Paper](https://github.com/coredipper/operon/tree/main/article)
|
requirements.txt
CHANGED
|
@@ -1,2 +1,2 @@
|
|
| 1 |
gradio>=4.0
|
| 2 |
-
operon-ai>=0.
|
|
|
|
| 1 |
gradio>=4.0
|
| 2 |
+
operon-ai>=0.15.0
|