Review automatically created annotations and add missing ones for `scikit-learn`

[lars-reimann]

Modules

-[ ] module.name; @"contributer"; number of selected elements; completion status; finished in iteration;

• sklearn.metrics; @lukarade; 227; 100%; 3
• sklearn.preprocessing @Aclrian; 159; 100%; 3
• sklearn.model_selection @DavidTen1; 198; 100%; 5
• sklearn.linear_model @nvollroth; 308; ~100%; / 4
• sklearn.feature_extraction.text @Masara; 93; 100%; 3
• sklearn.ensemble @GideonKoenig; 488; 100%; 5
• sklearn.base @jofaul; 25; 100%; 1
• sklearn.pipeline @jofaul; 46; 100%; 1
• sklearn.decomposition @jofaul; 123; 100%; 2
• sklearn.tree @jofaul; 85; 100%; 3
• sklearn.neighbors @jofaul; 90; 100%; 3
• sklearn.naive_bayes @jofaul; 33; 100%; 3
• sklearn.feature_selection @lukarade; 71; 100%; 4
• sklearn.calibration @Masara; 19; 100%; 3
• sklearn.svm @jofaul; 91; 100%, 3
• sklearn.cluster @Aclrian; 93; 100%; 4
• sklearn.impute @Masara; 43; 100%; 4
• sklearn.utils.* @jofaul; 55; 100%; 3
• sklearn.discriminant_analysis @jofaul; 27; 100%; 4
• sklearn.manifold @Masara; 63; 100%; 4
• sklearn.compose @jofaul; 38; 100%; 4
• sklearn.neural_network @jofaul; 62; 100%; 4
• sklearn.feature_extraction @jofaul; 18; 100%; 4
• sklearn.multiclass @jofaul; 23; 100%, 4
• sklearn.multioutput @jofaul; 21; 100%; 4
• sklearn.random_projection @Masara; 19; 100; 4
• sklearn.mixture @jofaul; 26; 100%; 4
• sklearn.covariance @jofaul; 44; 100%; 4
• sklearn @Masara; 10; 100%; 4
• sklearn.dummy @jofaul; 26; 100%; 4
• sklearn.datasets @Masara; 63; 100%; 4
• sklearn.metrics.pairwise @jofaul; 22; 100%; 4
• sklearn.kernel_ridge @jofaul; 13; 100%; 4
• sklearn.gaussian_process @Masara; 42; 100%; 4
• sklearn.inspection @jofaul; 17; 100%; 4
• sklearn.feature_extraction.image @lukarade; 10; 100%; 4
• sklearn.gaussian_process.kernels @jofaul; 42; 100%; 4
• sklearn.isotonic @lukarade; 10; 100%; 4
• sklearn.cross_decomposition @jofaul; 13; 100%; 4
• sklearn.kernel_approximation @jofaul; 11; 100%; 4
• sklearn.semi_supervised @lukarade; 12; 100%, 4

Recommended configuration of the GUI

1. Load the API data: data/api/sklearn__api.json
2. Load the usage data: data/usages/sklearn__usage_counts.json
3. Load the auto-generated annotations: data/annotations/sklearn__annotations.json
4. In settings:
   1. Set "Module/Class/Function Sorting" to "Usages (Descending)".
   2. Set "Heatmap Mode" to "Usefulness".
5. Set filter to is:public usefulness:>0. There should be 2810 matches.

[jofaul]

Regeln für Annotierung

Klassen

• description: nur typos, oder offensichtliche Fehler
• move: classification/regression nach sklearn.classification/regression verschieben. Dabei metric/model als Unterorder für regression/classification (z.B. sklearn.ensemble.RandomForestClassifier -> move to sklearn.classfication.model).
• rename: bei obigen moves zB das classifier/regressor aus namen entfernen
• remove: prüfen ob autogen remove passt, andere annotationen bei remove sind inkorrekt weil es wird gelöscht. auch: datasets alle entfernen.
• todo: alles was sonst auffällt aber nicht zu anderen annotationen passt (eher weniger verwenden)

Funktionen

• description/todo: wie bei klassen. eher meiden.
• remove: wie oben.
• pure: autogen; aber noch nicht vorhanden. ignorieren.
• calledAfter: eher bei methoden relevant, weniger bei globalen funktionen. beschreibung sagt "darf nur nach methode x aufgerufen werden" -> calledAfter setzen
• group: Parameter werden in Klasse gruppiert und dann wird statt 20 Parametern eine Klasse übergeben.
  Also z.B. alles was nichts mit ML zu tun hat (-> KlassenNameOther), oder Regularization, was bei Klassen Konstruktor die meisten Parameter mit min/max im Namen meint (-> KlassenNameRegularization)

Parameter

• attribute: ignorieren
• boundary: autogen, aber lange nicht immer. prüfen und oft selber hinzufügen, je nach description (nur konstante grenzen)
• constant: autogen, prüfen ob param nur einen wert hat. wenn nicht, bug. wenn nur ein wert, auch bug. annotation hinzufügen (default value beachten)
• description: wie oben
• enum: autogen, prüfen und beschreibung noch nicht gefundenen enums überprüfen.
• optional/required: autogen genau ansehen. balken müssen weit genug entfernt/nah genug aneinander sein. vllt manchmal lars fragen um ein gefühl zu bekommen
• rename: vllt bei dummen namen, sonst ignorieren.
• todo: dependancy annotation: Wenn ein Parameter nur Sinn macht und Abhängig von einem bestimmten Wert eines anderen Paramter ist. (Bitte den entsprechenden Teil der Description mit angeben.)

Allgemein

• verwirrende werte nach bedarf anpassen, rückfrage zu kunde vorher.