Skip to content

Commit 1a24c04

Browse files
committed
Fixed mdl error
1 parent 7b4b500 commit 1a24c04

File tree

1 file changed

+25
-21
lines changed

1 file changed

+25
-21
lines changed

README.md

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -251,64 +251,68 @@ grouping of students based on their preferences for working with other students
251251
and compatibility with other classmates. The graph recognizes student compatibility
252252
through numerical weights (indicators of student positional relationship on the graph).
253253
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...
257259

258260
NOTE: `--method graph` and `--num-group` are required to create groups.
259261

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`
262265

263266
```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
265269
```
266270

267271
To load student preferences, a preference weight, use the flag `--preferences`
268272

269273
```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
272276
```
273277

274278
To indicate student preference weight use the flag `--preferences_weight`
275279

276280
```shell
277-
pipenv run python gatorgrouper_cli.py --file filepath --method graph --num-group NUMBER
278-
--preferences filepath --preferences_weight PREFERENCES_WEIGHT
281+
pipenv run python gatorgrouper_cli.py --file filepath --method graph
282+
--num-group NUMBER --preferences filepath --preferences_weight PREFERENCES_WEIGHT
279283
```
280284

281285
To indicate preference weight match use the flag `--preferences_weight_match`
282286

283287
```shell
284-
pipenv run python gatorgrouper_cli.py --file filepath --method graph --num-group NUMBER
285-
--preferences filepath --preferences_weight PREFERENCES_WEIGHT --preferences_weight_match
286-
PREFERENCES_WEIGHT_MATCH
288+
pipenv run python gatorgrouper_cli.py --file filepath --method graph
289+
--num-group NUMBER --preferences filepath --preferences_weight PREFERENCES_WEIGHT
290+
--preferences_weight_match PREFERENCES_WEIGHT_MATCH
287291
```
288292

289293
To add objective measures use the flag `--objective_measures`
290294

291295
```shell
292-
pipenv run python gatorgrouper_cli.py --file filepath --method graph --num-group NUMBER
293-
--objective_measures LIST --objective_weights LIST
296+
pipenv run python gatorgrouper_cli.py --file filepath --method graph
297+
--num-group NUMBER --objective_measures LIST --objective_weights LIST
294298
```
295299

296300
To add objective weights use the flag `--objective_weights`
297301

298302
```shell
299-
pipenv run python gatorgrouper_cli.py --file filepath --method graph --num-group NUMBER
300-
--objective_measures LIST --objective_weights LIST
303+
pipenv run python gatorgrouper_cli.py --file filepath --method graph
304+
--num-group NUMBER --objective_measures LIST --objective_weights LIST
301305
```
302306

303307
A command line of all agruments would be:
304308

305309
```shell
306-
pipenv run python gatorgrouper_cli.py --file filepath --method graph --num-group NUMBER
307-
--preferences filepath --preferences-weight PREFERENCES_WEIGHT --preferences-weight-match
308-
PREFERENCES_WEIGHT_MATCH --objective-measures LIST --objective-weights LIST
310+
pipenv run python gatorgrouper_cli.py --file filepath --method graph
311+
--num-group NUMBER --preferences filepath --preferences-weight PREFERENCES_WEIGHT
312+
--preferences-weight-match PREFERENCES_WEIGHT_MATCH --objective-measures LIST
313+
--objective-weights LIST
309314
```
310315

311-
312316
### Full Example
313317

314318
```shell

0 commit comments

Comments
 (0)