saadbather commited on
Commit
7f181ec
·
verified ·
1 Parent(s): 3e3457b

Add concise demo entry point

Browse files
Files changed (1) hide show
  1. README.md +15 -35
README.md CHANGED
@@ -9,16 +9,10 @@ tags:
9
  - research
10
  ---
11
 
12
- # SwarmFL: authorized specialist consultation over Flower
13
 
14
- SwarmFL is a research framework for federated multi-agent inference. A specialist
15
- keeps its model and feature view on its own Flower client; an origin client may
16
- request a prediction from an authorized peer, then fuse only the predictions it
17
- actually received.
18
-
19
- This Hub card contains a small CPU-friendly synthetic quickstart for inspecting the
20
- communication and authorization path. It is an API demonstration, not a trained
21
- benchmark model or a clinical system.
22
 
23
  ## Quickstart
24
 
@@ -33,33 +27,19 @@ a selected one-peer consultation on a new case, and writes the fused probability
33
  and audit artifacts under `demo/`. The synthetic specialists use the ordered input
34
  views `(x0,x1)`, `(x2,x3)`, and `(x4,x5)`.
35
 
36
- ## What this demonstrates
37
-
38
- - isolated specialist identities and feature declarations;
39
- - authorization-aware, selected-peer consultation;
40
- - prediction fusion from observed responses only;
41
- - request-level feedback/audit output; and
42
- - deterministic local generation of the tiny demo adapters.
43
-
44
- It does not claim benchmark improvement, privacy, secure aggregation, differential
45
- privacy, clinical validity, or production readiness. The examples use synthetic
46
- inputs and labels. Do not infer performance on Wisconsin, CDC Diabetes, Adult, or
47
- any other dataset from this card.
48
 
49
- ## Scope and provenance
50
-
51
- The package and quickstart are released under Apache-2.0. This Hub publication
52
- intentionally excludes frozen test sets, private CDC artifacts, research checkpoints,
53
- raw experiment outputs, and paper-only figures. Those materials remain governed by
54
- their repository-specific access and provenance rules.
55
 
56
- For implementation details and the full research protocol, see the
57
- [SwarmFL repository](https://github.com/saadbinather/SwarmFL). Contributions and
58
- reproduction reports are welcome through GitHub issues.
59
 
60
- ## Hugging Face release
 
 
61
 
62
- This card is the lightweight SwarmFL Hub release: a small, reproducible entry
63
- point for trying the Flower consultation path without downloading research
64
- datasets or private checkpoints. The full research artifacts remain in the
65
- repository and are not part of this public demo.
 
9
  - research
10
  ---
11
 
12
+ # SwarmFL
13
 
14
+ Small Flower demo for authorized specialist consultation. Synthetic only; not a
15
+ benchmark or clinical model.
 
 
 
 
 
 
16
 
17
  ## Quickstart
18
 
 
27
  and audit artifacts under `demo/`. The synthetic specialists use the ordered input
28
  views `(x0,x1)`, `(x2,x3)`, and `(x4,x5)`.
29
 
30
+ The demo keeps specialist views separate, makes one selected peer request, and
31
+ fuses the observed predictions.
 
 
 
 
 
 
 
 
 
 
32
 
33
+ ```bash
34
+ python demo.py --feedback
35
+ ```
 
 
 
36
 
37
+ If needed, install the package first:
 
 
38
 
39
+ ```bash
40
+ pip install swarmfl==0.1.0
41
+ ```
42
 
43
+ The public Hub release contains no research datasets, frozen tests, private
44
+ checkpoints, or experiment outputs. See the [repository](https://github.com/saadbinather/SwarmFL)
45
+ for source and research context.