Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yudgugger authored Jun 26, 2024
1 parent 5aea321 commit b558aac
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1818,15 +1818,11 @@ The script can be executed directly using the executable file: <code><a href="ht
```

<p align="justify" width="100%">
Pour la description des paramètres, voir celle de vector clustering car les paramètres sont globalement identiques. Cependant, le paramètres <code>lim cluster</code> sets the maximum number of clusters for which inertia values are calculated and associated. Le script fait ensuite tourner le script <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/blob/main/PySSPFM/toolbox/vector_clustering.py">toolbox/vector_clustering.py</a></code> en incrémentant le nombre de cluster de 2 au nombre maximum rensigné par l'utilisateur, pour déterminer l'intertie de chaques configuration. L'inertie est alors tracé en fonction du nombre de cluster de la configuration. Le nombre de cluster optimal à choisir se situe au niveau du coude de la courbe.
</p>

<p align="justify" width="100%">
For the description of the parameters, see that of vector clustering as the parameters are generally the same. However, the parameter <code>lim cluster</code> sets the maximum number of clusters for which inertia values are calculated and associated. The script then runs the script <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/blob/main/PySSPFM/toolbox/vector_clustering.py">toolbox/vector_clustering.py</a></code> by incrementing the number of clusters from 2 to the maximum number specified by the user, to determine the inertia of each configuration. The inertia is then plotted against the number of clusters in the configuration. The optimal number of clusters to choose is located at the elbow of the curve.
For the description of the parameters, see that of vector clustering as the parameters are the same. However, the parameter <code>lim cluster</code> sets the maximum number of clusters for which inertia values are calculated and associated. The script then runs the script <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/blob/main/PySSPFM/toolbox/vector_clustering.py">toolbox/vector_clustering.py</a></code> by incrementing the number of clusters from 2 to the maximum number specified by the user, to determine the inertia of each configuration. The inertia is then plotted against the number of clusters in the configuration. The optimal number of clusters to choose is located at the elbow of the curve.
</p>

<p align="center" width="100%">
<img align="center" width="25%" src=https://github.com/CEA-MetroCarac/PySSPFM/blob/main/doc/_static/clustering_clusters_centroids.PNG>
<img align="center" width="50%" src=https://github.com/CEA-MetroCarac/PySSPFM/blob/main/doc/_static/inertia_vs_cluster.PNG>
<em>Result of clustering_inertia (figure generated with <code>main_clustering_inertia</code> function of <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/blob/main/PySSPFM/toolbox/clustering_inertia.py">toolbox/clustering_inertia.py</a></code> script)</em>
</p>

Expand Down

0 comments on commit b558aac

Please sign in to comment.