You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Nov 29, 2023. It is now read-only.
Is your feature request related to a problem? Please describe
Bisher müssen Annotations von Hand markiert werden.
Desired solution
Die Analyse der Daten, die in Form der usage.json und api.json Datei gegeben sind, soll daher nun automatisch geschehen und die Optional Annotations sollen als Teil der annotations.json datei exportiert werden.
Mehr Informationen zu den Details sind hier zu finden.
Additional context
Die Analazye eines Paramters ergeben das einer der Werte "überdurchschnittlich" oft verwendet wird.
Hier kann beispielweise die Anzahl der Aufrufe der beiden meist verwendeten Werte verglichen werden.
Der am meisten verwendete Wert sollte signifikant häufiger auftreten.
Sei n = Anzahl der Paramteter Werte.
Sei m die Anzahl der Aufrufe.
Die Differenz zwischen den Aufrufen des am meisten verwendete Wert und des zweit meist verwendeten Wert sollte dabei nicht kleiner als m/n sein.
Dieses Kriterium gilt als Orientierung und nicht als finale Bedingung. Das Kriterium muss leicht ersetzbar sein.
Implementations Informationen
In _generate_annotations.py:
def __get_optional_annotations(usages: UsageStore, api: API) -> dict["optionals", dict[str, dict[str, str]]]:
Rückgabetyp siehe Kommentar von Lars.
Der Aufruf soll anschließend den anderen in generate_annotations() beigefügt werden.
Edit: Change 2m/n to m/n since the first formula would not work for n=2.
The text was updated successfully, but these errors were encountered:
Is your feature request related to a problem? Please describe
Bisher müssen Annotations von Hand markiert werden.
Desired solution
Die Analyse der Daten, die in Form der usage.json und api.json Datei gegeben sind, soll daher nun automatisch geschehen und die Optional Annotations sollen als Teil der annotations.json datei exportiert werden.
Mehr Informationen zu den Details sind hier zu finden.
Additional context
Die Analazye eines Paramters ergeben das einer der Werte "überdurchschnittlich" oft verwendet wird.
Hier kann beispielweise die Anzahl der Aufrufe der beiden meist verwendeten Werte verglichen werden.
Der am meisten verwendete Wert sollte signifikant häufiger auftreten.
Sei n = Anzahl der Paramteter Werte.
Sei m die Anzahl der Aufrufe.
Die Differenz zwischen den Aufrufen des am meisten verwendete Wert und des zweit meist verwendeten Wert sollte dabei nicht kleiner als m/n sein.
Dieses Kriterium gilt als Orientierung und nicht als finale Bedingung. Das Kriterium muss leicht ersetzbar sein.
Implementations Informationen
In _generate_annotations.py:
def __get_optional_annotations(usages: UsageStore, api: API) -> dict["optionals", dict[str, dict[str, str]]]:
Rückgabetyp siehe Kommentar von Lars.
Der Aufruf soll anschließend den anderen in generate_annotations() beigefügt werden.
Edit: Change 2m/n to m/n since the first formula would not work for n=2.
The text was updated successfully, but these errors were encountered: