Skip to content

Commit d3e7848

Browse files
committed
update readme
1 parent 735563e commit d3e7848

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The input format is in a ```.csv``` file containing the statistics of each class
1212

1313
## Usage of Code - Plot the MCM
1414

15-
In order for the user to plot the MCM, first thing is to load the ```.csv``` file into a ```pandas``` dataframe and feed it to the ```compare``` function. The user should specify the ```fig_savename``` parameter in order to save the output figure in ```pdf``` and ```png``` formats.
15+
In order for the user to plot the MCM, first thing is to load the ```.csv``` file into a ```pandas``` dataframe and feed it to the ```compare``` function. The user should specify the ```pdf_savename```, ```png_savename```, ```csv_savename``` or ```tex_savename``` parameter in order to save the output figure in ```pdf```, ```png```, ```csv``` or ```tex``` formats respecively.
1616

1717
## Examples
1818

@@ -29,8 +29,8 @@ output_dir = '/output/directory/desired'
2929
MCM.compare(
3030
output_dir=output_dir,
3131
df_results=df_results,
32-
fig_savename='heatmap',
33-
load_analysis=False
32+
pdf_savename="heatmap",
33+
png_savename="heatmap",
3434
)
3535
```
3636

@@ -52,8 +52,9 @@ MCM.compare(
5252
output_dir=output_dir,
5353
df_results=df_results,
5454
excluded_col_comparates=['clf1','clf3'],
55-
fig_savename='heatline_vertical',
56-
load_analysis=False
55+
png_savename='heatline_vertical',
56+
tex_savename='heatline_vertical',
57+
include_ProbaWinTieLoss=True
5758
)
5859
```
5960

@@ -75,8 +76,8 @@ MCM.compare(
7576
output_dir=output_dir,
7677
df_results=df_results,
7778
excluded_row_comparates=['clf1','clf3'],
78-
fig_savename='heatline_vertical',
79-
load_analysis=False
79+
png_savename='heatline_horizontal',
80+
csv_savename='heatline_horizontal',
8081
)
8182
```
8283

@@ -88,8 +89,9 @@ MCM.compare(
8889

8990
The following python packages are required for the usage of the module:
9091

91-
1. ```numpy==1.23.5```
92-
2. ```pandas==1.5.2```
93-
3. ```matplotlib==3.6.2```
92+
1. ```numpy==1.24.4```
93+
2. ```pandas==2.0.3```
94+
3. ```matplotlib==3.7.4```
9495
4. ```scipy==1.10.0```
9596
5. ```baycomp==1.0```
97+
6. ```tqdm==4.66.1```

0 commit comments

Comments
 (0)