You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-21Lines changed: 25 additions & 21 deletions
Original file line number
Diff line number
Diff line change
@@ -251,64 +251,68 @@ grouping of students based on their preferences for working with other students
251
251
and compatibility with other classmates. The graph recognizes student compatibility
252
252
through numerical weights (indicators of student positional relationship on the graph).
253
253
This grouping method allows for a systematic approach and balanced number of student
254
-
groups capable of tackling different types of work. Students should enter student name,
255
-
number of groups, objective weights (optional), objective_measures(optional), students preferred to work with (optional), preference weight(optional), and preferences_weight_match(optional). Note that number of groups must be at least 2
256
-
and be a power of 2, i.e. 2, 4, 8...
254
+
groups capable of tackling different types of work. Students should enter student
255
+
name, number of groups, objective weights (optional), objective_measures(optional),
256
+
students preferred to work with (optional), preference weight(optional),
257
+
and preferences_weight_match(optional). Note that number of groups must be at
258
+
least 2 and be a power of 2, i.e. 2, 4, 8...
257
259
258
260
NOTE: `--method graph` and `--num-group` are required to create groups.
259
261
260
-
It is required to use the graph argument to generate groups through the graph partitioning.
261
-
To generate groups using the Kernighan-Lin grouping algorithm use the flag `--method graph`
262
+
It is required to use the graph argument to generate groups through the graph
263
+
partitioning. To generate groups using the Kernighan-Lin grouping algorithm use
264
+
the flag `--method graph`
262
265
263
266
```shell
264
-
pipenv run python gatorgrouper_cli.py --file filepath --method graph --num-group NUMBER
267
+
pipenv run python gatorgrouper_cli.py --file filepath --method graph
268
+
--num-group NUMBER
265
269
```
266
270
267
271
To load student preferences, a preference weight, use the flag `--preferences`
268
272
269
273
```shell
270
-
pipenv run python gatorgrouper_cli.py --file filepath --method graph --num-group NUMBER
271
-
--preferences filepath
274
+
pipenv run python gatorgrouper_cli.py --file filepath --method graph
275
+
--num-group NUMBER --preferences filepath
272
276
```
273
277
274
278
To indicate student preference weight use the flag `--preferences_weight`
275
279
276
280
```shell
277
-
pipenv run python gatorgrouper_cli.py --file filepath --method graph --num-group NUMBER
0 commit comments