Skip to content

Commit

Permalink
docs: fix args format (#111)
Browse files Browse the repository at this point in the history
  • Loading branch information
shenxiangzhuang authored Jul 31, 2024
1 parent c0c5b92 commit 180a4e0
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 0 deletions.
1 change: 1 addition & 0 deletions crowdkit/aggregation/classification/dawid_skene.py
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,7 @@ def _m_step(data: pd.DataFrame, probas: pd.DataFrame) -> "pd.Series[Any]": # ty

def fit(self, data: pd.DataFrame) -> "OneCoinDawidSkene": # type: ignore[override]
"""Fits the model to the training data with the EM algorithm.
Args:
data (DataFrame): The training dataset of workers' labeling results
which is represented as the `pandas.DataFrame` data containing `task`, `worker`, and `label` columns.
Expand Down
1 change: 1 addition & 0 deletions crowdkit/aggregation/classification/gold_majority_vote.py
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ def predict_proba(self, data: pd.DataFrame) -> pd.DataFrame:

def fit_predict(self, data: pd.DataFrame, true_labels: "pd.Series[Any]") -> "pd.Series[Any]": # type: ignore
"""Fits the model to the training data and returns the aggregated results.
Args:
data (DataFrame): The training dataset of workers' labeling results
which is represented as the `pandas.DataFrame` data containing `task`, `worker`, and `label` columns.
Expand Down
2 changes: 2 additions & 0 deletions crowdkit/aggregation/classification/kos.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ class KOS(BaseClassificationAggregator):

def fit(self, data: pd.DataFrame) -> "KOS":
"""Fits the model to the training data.
Args:
data (DataFrame): The training dataset of workers' labeling results
which is represented as the `pandas.DataFrame` data containing `task`, `worker`, and `label` columns.
Expand Down Expand Up @@ -111,6 +112,7 @@ def fit(self, data: pd.DataFrame) -> "KOS":

def fit_predict(self, data: pd.DataFrame) -> "pd.Series[Any]":
"""Fits the model to the training data and returns the aggregated results.
Args:
data (DataFrame): The training dataset of workers' labeling results
which is represented as the `pandas.DataFrame` data containing `task`, `worker`, and `label` columns.
Expand Down
1 change: 1 addition & 0 deletions crowdkit/aggregation/classification/zero_based_skill.py
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ def predict_proba(self, data: pd.DataFrame) -> pd.DataFrame:

def fit_predict(self, data: pd.DataFrame) -> "pd.Series[Any]":
"""Fits the model to the training data and returns the aggregated results.
Args:
data (DataFrame): The training dataset of workers' labeling results
which is represented as the `pandas.DataFrame` data containing `task`, `worker`, and `label` columns.
Expand Down

0 comments on commit 180a4e0

Please sign in to comment.