Commit b3054a0d authored by Yannick DAYER's avatar Yannick DAYER
Browse files

[doc] Fix typos in docstrings of entry points.

parent e9e6aa7d
Pipeline #61510 failed with stage
in 19 minutes and 8 seconds
......@@ -19,7 +19,7 @@ logger = logging.getLogger(__name__)
def save_json(data, path):
"""
Saves a dictionnary ``data`` in a json file at ``path``.
Saves a dictionary ``data`` in a json file at ``path``.
"""
with open(path, "w") as f:
json.dump(data, f)
......@@ -27,7 +27,7 @@ def save_json(data, path):
def load_json(path):
"""
Returns a dictionnary from a json file at ``path``.
Returns a dictionary from a json file at ``path``.
"""
with open(path, "r") as f:
return json.load(f)
......
......@@ -43,11 +43,11 @@ def rank_option(**kwargs):
@common_options.metrics_command(
common_options.METRICS_HELP.format(
names="FtA, FAR, FRR, FMR, FMNR, HTER",
names="FtA, FAR, FRR, FMR, FNMR, HTER",
criteria=CRITERIA,
score_format=SCORE_FORMAT,
hter_note="Note that FAR = FMR * (1 - FtA), FRR = FtA + FMNR * (1 - FtA) "
"and HTER = (FMR + FMNR) / 2",
hter_note="Note that FAR = FMR * (1 - FtA), FRR = FtA + FNMR * (1 - FtA) "
"and HTER = (FMR + FNMR) / 2",
command="bob bio metrics",
),
criteria=CRITERIA,
......@@ -66,7 +66,7 @@ def metrics(ctx, scores, evaluation, **kwargs):
score_format=SCORE_FORMAT, command="bob bio roc"
)
)
def roc(ctx, scores, evaluation, **kargs):
def roc(ctx, scores, evaluation, **kwargs):
process = bio_figure.Roc(ctx, scores, evaluation, load.split)
process.run()
......@@ -76,7 +76,7 @@ def roc(ctx, scores, evaluation, **kargs):
score_format=SCORE_FORMAT, command="bob bio det"
)
)
def det(ctx, scores, evaluation, **kargs):
def det(ctx, scores, evaluation, **kwargs):
process = bio_figure.Det(ctx, scores, evaluation, load.split)
process.run()
......@@ -86,7 +86,7 @@ def det(ctx, scores, evaluation, **kargs):
score_format=SCORE_FORMAT, command="bob bio epc"
)
)
def epc(ctx, scores, **kargs):
def epc(ctx, scores, **kwargs):
process = measure_figure.Epc(ctx, scores, True, load.split)
process.run()
......@@ -116,7 +116,7 @@ def evaluate(ctx, scores, evaluation, **kwargs):
@common_options.multi_metrics_command(
common_options.MULTI_METRICS_HELP.format(
names="FtA, FAR, FRR, FMR, FMNR, HTER",
names="FtA, FAR, FRR, FMR, FNMR, HTER",
criteria=CRITERIA,
score_format=SCORE_FORMAT,
command="bob bio multi-metrics",
......@@ -145,7 +145,7 @@ def multi_metrics(ctx, scores, evaluation, protocols_number, **kwargs):
@common_options.figsize_option()
@verbosity_option()
@click.pass_context
def cmc(ctx, scores, evaluation, **kargs):
def cmc(ctx, scores, evaluation, **kwargs):
"""Plot CMC (cumulative match characteristic curve).
graphical presentation of results of an identification task eval, plotting
rank values on the x-axis and the probability of correct identification at
......@@ -190,7 +190,7 @@ def cmc(ctx, scores, evaluation, **kargs):
@common_options.min_far_option()
@verbosity_option()
@click.pass_context
def dir(ctx, scores, evaluation, **kargs):
def dir(ctx, scores, evaluation, **kwargs):
"""Plots the Detection & Identification Rate curve over the FAR.
This curve is designed to be used in an open set identification protocol,
......
......@@ -37,13 +37,13 @@ def weighted_neg_error_rate_criteria(
- data - the development data used to determine the threshold. List on 4
numpy.arrays containing: negatives (licit), positives (licit),
negatives (spoof), positivies (spoof)
negatives (spoof), positives (spoof)
- weight - the weight parameter balancing between impostors and spoofing
attacks
- thres - the given threshold
- beta - the weight parameter balancing between real accesses and all the
negative samples (impostors and spoofing attacks). Note that this
parameter will be overriden and not considered if the selected criteria
parameter will be overridden and not considered if the selected criteria
is 'min-hter'.
- criteria - 'eer', 'wer' or 'min-hter' criteria for decision threshold
"""
......@@ -99,7 +99,7 @@ def recursive_thr_search(
Keyword arguments:
- data - the development data used to determine the threshold. List on 4
numpy.arrays containing: negatives (licit), positives (licit), negatives
(spoof), positivies (spoof)
(spoof), positives (spoof)
- span_min - the minimum of the search range
- span_max - the maximum of the search range
- weight - the weight parameter balancing between impostors and spoofing
......
......@@ -252,7 +252,7 @@ You can observe the distributions histograms in a pdf file with:
default=0,
type=click.INT,
show_default=True,
help="Number of unknown subjects (useful for openset plots)",
help="Number of unknown subjects (useful for open-set plots)",
)
@click.option(
"-f",
......
......@@ -41,7 +41,7 @@ Creating my own transformer\n
---------------------------\n
This command accepts configuration file as input.\n
For example, if you desire to customize your transfomer, you can use the following configuration file:\n
For example, if you desire to customize your transformer, you can use the following configuration file:\n
\b\b
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment