Update README.md

README.md

@@ -1,3 +1,71 @@
----
-license: gpl-3.0
----
+---
+license: gpl-3.0
+tags:
+  - lora
+  - merge
+  - comfyui
+  - stable-diffusion
+---
+
+# LoRA Optimizer — Community Cache
+
+Shared analysis results for the [LoRA Optimizer](https://github.com/ethanfel/ComfyUI-LoRA-Optimizer) ComfyUI node.
+
+LoRA merge analysis is hardware-agnostic — the same LoRA files always produce the same conflict metrics and optimal merge config regardless of GPU tier. This dataset lets users share and reuse those results so nobody has to run the AutoTuner from scratch.
+
+---
+
+## How It Works
+
+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.
+
+When `community_cache=download_only` or `upload_and_download` is set in the AutoTuner node:
+
+- **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.
+- **Upload:** After a successful sweep, results are uploaded if the local score beats the current community score for that LoRA set.
+
+---
+
+## Privacy
+
+**LoRA filenames are never stored here.** Only SHA256[:16] content hashes are used as keys. The uploaded data contains:
+- Per-prefix conflict metrics (cosine similarity, sign conflict ratios, subspace overlap)
+- Winning merge configuration (sparsification method, merge strategy, refinement level, etc.)
+- A composite quality score
+
+No file paths, no usernames, no LoRA names.
+
+---
+
+## File Structure
+
+```
+lora/
+  {content_hash}.lora.json       # Per-LoRA per-prefix conflict stats
+pair/
+  {hash_a}_{hash_b}.pair.json   # Pairwise conflict metrics (hashes sorted)
+config/
+  {hash_a}_{hash_b}_..._{arch}.config.json  # Best merge config + score for a LoRA set
+```
+
+All files include an `algo_version` field. Results from incompatible algorithm versions are ignored automatically.
+
+---
+
+## Usage
+
+In the **LoRA AutoTuner** node, set `community_cache` to:
+
+| Value | Behavior |
+|-------|----------|
+| `disabled` | No network interaction (default) |
+| `download_only` | Download precomputed results anonymously — no account needed |
+| `upload_and_download` | Also contribute your results. Requires `HF_TOKEN` env var with write access and `huggingface_hub` installed (`pip install huggingface_hub`) |
+
+Network errors are silently ignored — the node always falls back to local computation.
+
+---
+
+## Contributing
+
+Run the AutoTuner with `community_cache=upload_and_download`. Your results are uploaded automatically after each sweep if they beat the current community score. No manual steps needed.