ethanfel commited on
Commit
9640807
·
verified ·
1 Parent(s): 842b8aa

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +15 -12
README.md CHANGED
@@ -19,10 +19,10 @@ LoRA merge analysis is hardware-agnostic — the same LoRA files always produce
19
 
20
  The AutoTuner computes pairwise conflict metrics (cosine similarity, sign conflicts, subspace overlap) and tests merge parameter combinations to find the best config for a set of LoRAs. These results are keyed by **content hash** (SHA256[:16] of file contents) — not by filename — so they're portable across systems and private by design.
21
 
22
- When `community_cache=download_only` or `upload_and_download` is set in the AutoTuner node:
23
 
24
  - **Download:** Before running analysis, the node checks this dataset for existing results. A config hit skips the entire sweep (~30–120s saved). Lora/pair cache hits speed up the analysis phase even without a full config hit.
25
- - **Upload:** After a successful sweep, results are uploaded if the local score beats the current community score for that LoRA set.
26
 
27
  ---
28
 
@@ -54,31 +54,34 @@ All files include an `algo_version` field. Results from incompatible algorithm v
54
 
55
  ## Usage
56
 
57
- In the **LoRA AutoTuner** node, set `community_cache` to:
58
 
59
  | Value | Behavior |
60
  |-------|----------|
61
- | `disabled` | No network interaction (default) |
62
- | `download_only` | Download precomputed results anonymously no account needed |
63
- | `upload_and_download` | Also contribute your results. Requires a Hugging Face account and `huggingface_hub` installed |
64
 
65
  Network errors are silently ignored — the node always falls back to local computation.
66
 
67
  ---
68
 
69
- ## Contributing
70
 
71
- **Setup (one time):**
72
 
73
  ```bash
74
  pip install huggingface_hub
75
  huggingface-cli login
76
  ```
77
 
78
- That's it. The node picks up your stored token automatically.
79
 
80
- Alternatively, set `HF_TOKEN` as an environment variable (useful for headless/server setups).
81
 
82
- **To contribute results:**
83
 
84
- Set `community_cache=upload_and_download` in the AutoTuner node and run as normal. Results are uploaded automatically after each sweep if your score beats the current community score for that LoRA set. No other steps needed.
 
 
 
 
 
19
 
20
  The AutoTuner computes pairwise conflict metrics (cosine similarity, sign conflicts, subspace overlap) and tests merge parameter combinations to find the best config for a set of LoRAs. These results are keyed by **content hash** (SHA256[:16] of file contents) — not by filename — so they're portable across systems and private by design.
21
 
22
+ When `community_cache=upload_and_download` is set in the AutoTuner node:
23
 
24
  - **Download:** Before running analysis, the node checks this dataset for existing results. A config hit skips the entire sweep (~30–120s saved). Lora/pair cache hits speed up the analysis phase even without a full config hit.
25
+ - **Upload:** After a successful sweep (or when replaying from local memory), results are uploaded if the local score beats the current community score for that LoRA set.
26
 
27
  ---
28
 
 
54
 
55
  ## Usage
56
 
57
+ In the **LoRA AutoTuner** node, set `community_cache` to `upload_and_download`. That's the only option — there's no passive download-only mode. If you benefit from the cache, you contribute back.
58
 
59
  | Value | Behavior |
60
  |-------|----------|
61
+ | `disabled` (default) | No network interaction |
62
+ | `upload_and_download` | Download precomputed results and contribute yours back |
 
63
 
64
  Network errors are silently ignored — the node always falls back to local computation.
65
 
66
  ---
67
 
68
+ ## Setup
69
 
70
+ **One time:**
71
 
72
  ```bash
73
  pip install huggingface_hub
74
  huggingface-cli login
75
  ```
76
 
77
+ The node picks up your stored token automatically. No environment variables needed for most users.
78
 
79
+ **Headless/server alternative:** set `HF_TOKEN` as an environment variable.
80
 
81
+ **Then:** set `community_cache=upload_and_download` in the AutoTuner node and run as normal. Everything else is automatic.
82
 
83
+ ---
84
+
85
+ ## Score-Based Replacement
86
+
87
+ Configs are only uploaded when your local score beats the community score. Users with more thorough sweeps (`top_n=10`) or better hardware naturally contribute higher-quality results over time.