Skip to content

docs - metrics namespace #57

@hjrnunes

Description

@hjrnunes

many docstrings in the tech.v3.ml.metrics namespace seem wrong/outdated.

The ones in question generally state or imply returns to be arrays of 0.0 and 1.0 values. In reality, booleans are returned because tech.v3.datatype.functional/eq or tech.v3.datatype.functional/not-eq are used underneath.

Examples:

(require '[tech.v3.ml.metrics :as m])

(doc m/wrongs)
-------------------------
tech.v3.ml.metrics/wrongs
([y y_hat])
  Given `y` array of ground truth labels and `y_hat` classifier predictions,
  returns array with 1.0 values where `y` does not equal `y_hat`.

(m/wrongs [:a :a :b] [:a :a :a])
=> [false false true]


(doc m/true-negatives)
-------------------------
tech.v3.ml.metrics/true-negatives
([y y_hat])
  Returns array with 1. values assigned to true negatives.

(m/true-negatives [1.0 1.0 0.0] [1.0 1.0 1.0])
=> [false false false]

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions