@@ -23,7 +23,7 @@ It also provides functions for pruning the NN in order to display the **n** “m
2323nnplot is available via pip:
2424
2525``` bash
26- pip install nnplot
26+ pip install nnplot
2727```
2828/TODO - dependencies?
2929
@@ -51,7 +51,7 @@ from nnplot.functions import prune
5151
5252
5353
54- To make the most out of the functions mentioned above, try using their optional flags (use examples follows ):
54+ To make the most out of the functions mentioned above, try using their optional flags (examples follow ):
5555
5656** plot:**
5757
@@ -72,16 +72,23 @@ plot_net(model,
7272Arguments:
7373
7474` model ` : A Keras model instance.
75+
7576` view ` : whether to plot the model on screen after its generation.
77+
7678` filename ` : path and name to save the visualization outcome, as a * PDF* and a * .gv* (graph-viz) file.
79+
7780` title ` : A title for the graph.
81+
7882` color_edges ` : whether to visualize the weights of the edges as colors.
79- options:
8083
81- - "*rb*" - Red / Black: red for positive edges and black for negative ones.
82- - "*mc*" - Multi Colored: all edges that converge into the same node, have the same (unique) color.
83- - "*none*" - all edges painted black (but thickness visualization remains).
84+ options:
85+
86+ - "* rb* " - Red / Black: red for positive edges and black for negative ones.
87+ - "* mc* " - Multi Colored: all edges that converge into the same node, have the same (unique) color.
88+ - "* none* " - all edges painted black (but thickness visualization remains).
89+
8490` print_weights ` : whether to print the weights of the edges to the screen.
91+
8592` size_limit ` : max number of nodes in each layer (simply the first * n* nodes, use ** prune** for a more complex node selection).
8693
8794** prune:**
@@ -97,13 +104,19 @@ from nnplot.functions import prune
97104```
98105
99106Arguments:
107+
100108` model ` : A Keras model instance.
109+
101110` max_limit ` : maximal number of nodes on each layer. ([ How are the nodes picked in this prune?] ( \TODO ) )
111+
102112` input_list ` : list of input names, so that the new * input_indexes* output will have their original names.
113+
103114` verbose ` : print information of the process along the way.
104115
105116Outputs:
117+
106118` network ` : the new pruned network.
119+
107120` input_indexs ` : the indexes of the chosen inputs
108121
109122
0 commit comments