Skip to content

Commit 3b6ccfe

Browse files
authored
Update hyperparameter description.
1 parent 8d16f36 commit 3b6ccfe

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ The extension contains two reporters, `cluster-by-variable` and `cluster-by-loca
1111

1212
Syntax: `cluster-by-variable` *agents-to-be-clustered* *cluster-variable* *minimum-members* *maximum-distance*
1313

14-
Clusters a given agentset *agents-to-be-clustered* by variable *cluster-variable*, requiring a minimum of *minimum-members* agents to constitute a cluster within a range of variable value difference, with the maximum value difference being *maximum-distance*.
14+
Clusters a given agentset *agents-to-be-clustered* by individual-level variable *cluster-variable*, along with two hyperparameters required for the operation of DBSCAN:
15+
* *minimum-members*: a minimum number of agents to constitute a cluster, and
16+
* *maximum-distance*: the maximum cluster variable value difference within a cluster.
1517

1618
The reporter returns a nested list of clustered agents.
1719

@@ -63,7 +65,9 @@ let ctr 1
6365

6466
Syntax: `cluster-by-location` *agents-to-be-clustered* *minimum-members* *maximum-distance*
6567

66-
Clusters a given agentset *agents-to-be-clustered* by proximity, requiring a minimum of *minimum-members* agents to constitute a cluster with a maximum distance *maximum-distance*.
68+
Clusters a given agentset *agents-to-be-clustered* by proximity, along with two hyperparameters required for the operation of DBSCAN:
69+
* *minimum-members*: a minimum number of agents to constitute a cluster, and
70+
* *maximum-distance*: the maximum permissible distance between agents within a cluster.
6771

6872
The reporter returns a nested list of clustered agents.
6973

0 commit comments

Comments
 (0)