From 17f18477ddcfba6160571a54d4c068951c989d5c Mon Sep 17 00:00:00 2001
From: TooSeriuz <frongs@rfcx.org>
Date: Tue, 16 Jan 2024 15:28:41 +0700
Subject: [PATCH] Add docs, and change example

---
 docs/rfcx/client.html              |  2 +-
 package-rfcx/example-classifier.py | 10 +++++-----
 package-rfcx/rfcx/client.py        |  2 +-
 3 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/docs/rfcx/client.html b/docs/rfcx/client.html
index 38b1303..f3dc89d 100644
--- a/docs/rfcx/client.html
+++ b/docs/rfcx/client.html
@@ -326,7 +326,7 @@ <h2 id="args">Args</h2>
 <dt><strong><code>version</code></strong></dt>
 <dd>(required) Classifier version</dd>
 <dt><strong><code>classification_values</code></strong></dt>
-<dd>(required) List of mappings from model class name to classification values</dd>
+<dd>(required) List of mappings from model class name to classification values to ignore threshold (from_model_class_name[:to_classification_value][:ignore_threshold])</dd>
 </dl>
 <h2 id="returns">Returns</h2>
 <p>Identifier for created classifier (int)</p></div>
diff --git a/package-rfcx/example-classifier.py b/package-rfcx/example-classifier.py
index 834b84d..09a29b4 100644
--- a/package-rfcx/example-classifier.py
+++ b/package-rfcx/example-classifier.py
@@ -17,11 +17,11 @@
 # classification_values = [c['value'] for c in classifications]
 # print(f'Selected classification values: {",".join(classification_values)}')
 classification_values = [
-    # model_output_class:rfcx_classification_value
-    'Sciurus_carolinensis_simple_call:sciurus_carolinensis_simple_call_1',
-    'Sciurus_carolinensis_simple_call_2:sciurus_carolinensis_simple_call_2', 
-    'Sciurus_vulgaris_simple_call:sciurus_vulgaris_simple_call_1', 
-    'Sciurus_vulgaris_simple_call_2:sciurus_vulgaris_simple_call_2']
+    # model_output_class[:rfcx_classification_value][:ignore_threshold]
+    'Sciurus_carolinensis_simple_call:sciurus_carolinensis_simple_call_1:0.4',
+    'Sciurus_carolinensis_simple_call_2:sciurus_carolinensis_simple_call_2:0.2', 
+    'Sciurus_vulgaris_simple_call:sciurus_vulgaris_simple_call_1:1.0', 
+    'Sciurus_vulgaris_simple_call_2:sciurus_vulgaris_simple_call_2:0.1']
 
 # Upload the model
 filepath = 'squirrel.tar.gz'
diff --git a/package-rfcx/rfcx/client.py b/package-rfcx/rfcx/client.py
index 8a76afe..e369efb 100644
--- a/package-rfcx/rfcx/client.py
+++ b/package-rfcx/rfcx/client.py
@@ -343,7 +343,7 @@ def upload_classifier(self, filepath, name, version, classification_values) -> i
             filepath: (required) Path of the local file (tar.gz) containing the model (currently only supports RFCx's tf2 format)
             name: (required) Classifier name
             version: (required) Classifier version
-            classification_values: (required) List of mappings from model class name to classification values
+            classification_values: (required) List of mappings from model class name to classification values to ignore threshold (from_model_class_name[:to_classification_value][:ignore_threshold])
 
         Returns:
             Identifier for created classifier (int)