From 2ab7ecf91d7cdb55d05fcbc5076e5c2635ce9c1f Mon Sep 17 00:00:00 2001 From: lucas de oliveira carvalho Date: Tue, 11 Oct 2022 09:28:53 -0300 Subject: [PATCH] Fix README.md --- scripts/Confusion_Matrix/README.md | 31 +++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/scripts/Confusion_Matrix/README.md b/scripts/Confusion_Matrix/README.md index 69bdc2a..30c0c4f 100644 --- a/scripts/Confusion_Matrix/README.md +++ b/scripts/Confusion_Matrix/README.md @@ -1,24 +1,25 @@ -# CODE BY ZeroToMastery TensorFlow course. -# The function makes a labelled confusion matrix comparing predictions and ground truth labels. +The function makes a labelled confusion matrix comparing predictions and ground truth labels. -# If classes is passed, confusion matrix will be labelled, if not, integer class values -# will be used. +If classes is passed, confusion matrix will be labelled, if not, integer class values will be used. -## Args: +Args: -`y_true`: Array of truth labels (must be same shape as y_pred). -`y_pred`: Array of predicted labels (must be same shape as y_true). -`classes`: Array of class labels (e.g. string form). If `None`, integer labels are used. -`figsize`: Size of output figure (default=(10, 10)). -`text_size`: Size of output figure text (default=15). -`norm`: normalize values or not (default=False). -`savefig`: save confusion matrix to file (default=False). +* `y_true`: Array of truth labels (must be same shape as y_pred). +* `y_pred`: Array of predicted labels (must be same shape as y_true). +* `classes`: Array of class labels (e.g. string form). If `None`, integer labels are used. +* `figsize`: Size of output figure (default=(10, 10)). +* `text_size`: Size of output figure text (default=15). +* `norm`: normalize values or not (default=False). +* `savefig`: save confusion matrix to file (default=False). + +Returns: A labelled confusion matrix plot comparing y_true and y_pred. -## Returns: A labelled confusion matrix plot comparing y_true and y_pred. ### Example usage: -"""make_confusion_matrix(y_true=test_labels, # ground truth test labels +> """make_confusion_matrix(y_true=test_labels, # ground truth test labels y_pred=y_preds, # predicted labels classes=class_names, # array of class label names figsize=(15, 15), - text_size=10)""" \ No newline at end of file + text_size=10)""" + +#### CODE BY ZeroToMastery TensorFlow course.