test.test_metrics

Complexity

Total Complexity

9

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Importance

Changes

0

8 Functions

Rating	Name	Duplication	Size	Complexity
A	test_b_cubed()	0	9	1
A	example_clusters()	0	7	1
A	test_corefevaluator()	0	11	1
A	test_f1()	0	6	1
A	test_ceafe()	0	8	1
A	test_muc()	0	9	1
A	test_evaluate_documents()	0	11	2
A	test_f1_zero()	0	6	1

import e2edutch.metrics

Missing module docstring

import math

standard import "import math" should be placed before "import e2edutch.metrics"

def test_f1():

Missing function or method docstring

    num = 10
    p_den = 100
    r_den = 50
    f1 = e2edutch.metrics.f1(num, p_den, num, r_den)

Variable name "f1" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

    assert math.isclose(f1, 2.0/15)


def test_f1_zero():

Missing function or method docstring

    num = 0
    p_den = 0
    r_den = 0
    f1 = e2edutch.metrics.f1(num, p_den, num, r_den)

Variable name "f1" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

    assert math.isclose(f1, 0)


def test_corefevaluator():

Missing function or method docstring

    evaluator = e2edutch.metrics.CorefEvaluator()
    assert evaluator.get_f1() == 0
    assert evaluator.get_recall() == 0
    assert evaluator.get_precision() == 0

    # empty update
    evaluator.update([], [], {}, {})
    assert evaluator.get_f1() == 0
    assert evaluator.get_recall() == 0
    assert evaluator.get_precision() == 0


def test_evaluate_documents():

Missing function or method docstring

    metrics = [e2edutch.metrics.muc,
               e2edutch.metrics.b_cubed,
               e2edutch.metrics.lea,
               e2edutch.metrics.ceafe]
    documents = []
    for metric in metrics:
        p, r, f = e2edutch.metrics.evaluate_documents(documents, metric)

Variable name "p" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

Variable name "r" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

Variable name "f" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        assert p == 0
        assert r == 0
        assert f == 0


def example_clusters():

Missing function or method docstring

    mentions = tuple([(i*2, i*2+1) for i in range(9)])
    a, b, c, d, e, f, g, h, i = mentions

Variable name "a" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

Variable name "b" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

Variable name "c" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

Variable name "d" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

Variable name "e" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

Variable name "f" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

Variable name "g" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

Variable name "h" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

    pred_clusters = [(a, b), (c, d), (f, g, h, i)]
    gold_clusters = [(a, b, c), (d, e, f, g)]
    mentions_to_gold = {m: cl for cl in tuple(gold_clusters) for m in cl}
    return pred_clusters, gold_clusters, mentions_to_gold


def test_muc():

Missing function or method docstring

    clusters = [((0, 1), (2, 3))]
    mentions_to_gold = {m: cl for cl in tuple(clusters) for m in cl}
    num, dem = e2edutch.metrics.muc(clusters, mentions_to_gold)
    assert math.isclose(num/dem, 1)

    clusters, _, mentions_to_gold = example_clusters()
    num, dem = e2edutch.metrics.muc(clusters, mentions_to_gold)
    assert math.isclose(num/dem, 0.4)


def test_b_cubed():

Missing function or method docstring

    clusters = [((0, 1), (2, 3))]
    mentions_to_gold = {m: cl for cl in tuple(clusters) for m in cl}
    num, dem = e2edutch.metrics.b_cubed(clusters, mentions_to_gold)
    assert math.isclose(num/dem, 1)

    clusters, _, mentions_to_gold = example_clusters()
    num, dem = e2edutch.metrics.b_cubed(clusters, mentions_to_gold)
    assert math.isclose(num/dem, 0.5)


def test_ceafe():

Missing function or method docstring

    clusters = [((0, 1), (2, 3))]
    pn, pd, rn, rd = e2edutch.metrics.ceafe(clusters, clusters)

Variable name "pn" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

Variable name "pd" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

Variable name "rn" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

Variable name "rd" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

The variable rn seems to be unused.

The variable rd seems to be unused.

    assert math.isclose(pn/pd, 1)

    clusters, gold_clusters, _ = example_clusters()
    pn, pd, rn, rd = e2edutch.metrics.ceafe(clusters, gold_clusters)

Variable name "pn" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

Variable name "pd" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

Variable name "rn" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

Variable name "rd" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

    assert math.isclose(pn/pd, 0.43, abs_tol=0.005)