Skip to content

Commit 00b5d88

Browse files
authored
Update README.md
- Can change the command line SEMAG for graphs, SEMAC for classification.... and SEMAFL for federated learning? - I think should not mention default families here. We can mention that in our provided model such as our model is trained on the dataset of these families... - Some arguments are not necessary in DL. So I suggest to remove them. - nparts argument? what do you use it for? I think we use a specific training folder in client's argument instead of using nparts. - I think it's not necessary to show screen command here, but can use it in the example.
1 parent 125db94 commit 00b5d88

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -279,16 +279,16 @@ python3 ToolChainClassifier.py FOLDER/FILE
279279
* `classifier` : Classifier used [gspan,inria,wl,dl] (default : wl)
280280
* `threshold` : Threshold used for the classifier [0..1] (default : 0.45)
281281
* `support` : Support used for the gspan classifier [0..1] (default : 0.75)
282-
* `ctimeout` : Timeout for gspan classifier (default : 3sec)
282+
* `ctimeout` : Timeout for gspan classifier (default : 3sec) (??? what is 3sec?? can one write the command with the argument like "ctimeout 3sec" or "ctimeout 3". What does it (3sec) mean?)
283283
* `biggest_subgraph` : Biggest subgraph used with gspan (default : 5)
284-
* `nthread` : Number of thread used (default : max)
284+
* `nthread` : Number of thread used (default : max) (?? what is max ?)
285285
* `families`: Families considered (default : ['bancteian','delf','FeakerStealer','gandcrab','ircbot','lamer','nitol','RedLineStealer','sfone','sillyp2p','simbot','Sodinokibi','sytro','upatre','wabot','RemcosRAT'])"
286286
* `epoch` : Only for deep learning model: number of epoch (default : 5)
287-
* `sepoch` : Only for deep learning model: starting epoch (default : 1)
288-
* `data_scale` : Only for deep learning model: data scale value (default: 0.9)
289-
* `vector_size` : Only for deep learning model: Size of the vector used (default: 4)
290-
* `batch_size` : Only for deep learning model: batch size for the model(default: 1)
291-
* `smodel` : Only for deep learning model: Share model type, 1 partly aggregation (client do not have necessary the same family samples) and 0 fully aggregation (default: 0)
287+
* `sepoch` : Only for deep learning model: starting epoch (default : 1) (Remove)
288+
* `data_scale` : Only for deep learning model: data scale value (default: 0.9) (Remove)
289+
* `vector_size` : Only for deep learning model: Size of the vector used (default: 4) (Remove)
290+
* `batch_size` : Only for deep learning model: batch size for the model(default: 1) (Remove.. It is always 1)
291+
* `smodel` : Only for deep learning model: Share model type, 1 partly aggregation (client do not have necessary the same family samples) and 0 fully aggregation (default: 0) (Remove here, it is used for only Federated learning)
292292
293293
294294
@@ -332,9 +332,9 @@ pypy3 ToolChainFL.py --hostnames <listname> BINARY_NAME
332332
python3 ToolChainFL.py --hostnames <listname> BINARY_NAME
333333
```
334334
* `nrounds` : Number of rounds for training (default : 5)
335-
* `sround` : Restart from sround (default : 0)
336-
* `nparts` : Number of partitions (default : 3)
337-
* `FLRtrain` : FL train rotate (default : False)
335+
* `sround` : Restart from sround (default : 0) (Remove)
336+
* `nparts` : Number of partitions (default : 3) (what is nparts here? remove)
337+
* `FLRtrain` : FL train rotate (default : False) (Remove)
338338
* `demonstration` : If set, use specific dataset for each client (up to 3) to simulate different dataset in clients, else use the same input folder dataset for all clients (default : False)
339339
* `hostnames` : Hostnames for celery clients
340340

0 commit comments

Comments
 (0)