diff --git a/docs/how_it_works/business_value.rst b/docs/how_it_works/business_value.rst index 35d4d9ea..e4cce72f 100644 --- a/docs/how_it_works/business_value.rst +++ b/docs/how_it_works/business_value.rst @@ -55,6 +55,13 @@ observations in that cell of the :term:`confusion matrix`. Usi matrix notation the element on the i-th row and j-column of the business value matrix tells us the value of the i-th target when we have predicted the j-th value. +.. note:: + In Multiclass classification the classes are ordered alphanumerically. + This is used in the creation of the confusion matrix. The rows of the confusion matrix + represent target values in the corresponding alphanumerical order. And the columns + of the confusion matrix represent predicted classes in the same alphanumerical order. + Therefore the elements of the business value matrix should be constructed accordingly. + For binary classification this formula is easier to manage hence we will use it as an example. Classificatio problems with more classes follow the same pattern. Using the `sklearn confusion matrix convention`_ we designate label 0 as negative and label 1 as positive. diff --git a/docs/tutorials/performance_calculation/multiclass_performance_calculation/business_value_calculation.rst b/docs/tutorials/performance_calculation/multiclass_performance_calculation/business_value_calculation.rst index 4e085661..ea4af65a 100644 --- a/docs/tutorials/performance_calculation/multiclass_performance_calculation/business_value_calculation.rst +++ b/docs/tutorials/performance_calculation/multiclass_performance_calculation/business_value_calculation.rst @@ -88,7 +88,10 @@ the following parameter specifications: The format of the business value matrix must be specified so that each element represents the business value of it's respective confusion matrix element. Hence the element on the i-th row and j-column of the business value matrix tells us the value of the i-th target when we have predicted the j-th value. - It can be provided as a list of lists or a numpy array. + The target values that each column and row refer are sorted alphanumerically for both + the confusion matrix and the business value matrices. + + The business value matrix can be provided as a list of lists or a numpy array. For more information about the business value matrix, check out the :ref:`Business Value "How it Works" page`. diff --git a/docs/tutorials/performance_estimation/multiclass_performance_estimation/business_value_estimation.rst b/docs/tutorials/performance_estimation/multiclass_performance_estimation/business_value_estimation.rst index dae8d3f7..19e1c26e 100644 --- a/docs/tutorials/performance_estimation/multiclass_performance_estimation/business_value_estimation.rst +++ b/docs/tutorials/performance_estimation/multiclass_performance_estimation/business_value_estimation.rst @@ -80,7 +80,10 @@ parameters: The format of the business value matrix must be specified so that each element represents the business value of it's respective confusion matrix element. Hence the element on the i-th row and j-column of the business value matrix tells us the value of the i-th target when we have predicted the j-th value. - It can be provided as a list of lists or a numpy array. + The target values that each column and row refer are sorted alphanumerically for both + the confusion matrix and the business value matrices. + + The business value matrix can be provided as a list of lists or a numpy array. For more information about the business value matrix, check out the :ref:`Business Value "How it Works" page`.