Skip to content

Commit 3809a95

Browse files
committed
mf
1 parent 759fec1 commit 3809a95

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

documentation/organizers/organizing-tasks.rst

+31
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,37 @@ This code will work inside and outside the TIRA sandbox (within the sandbox thst
166166

167167
Now that the data is available, please configure next its evaluation by adding an `Evaluator <#add-an-evaluator>`_.
168168

169+
170+
171+
------
172+
173+
Test your Evaluator
174+
~~~~~~~~~~~~~~~~~~~
175+
176+
177+
As soon as you have `added a dataset <#add-a-new-dataset>`_ and `configured the evaluator <#add-an-evaluator>`_, you can test it locally and in TIRA.io. In the following, we assume that you have predictions in a directory ``my-predictions``.
178+
179+
180+
.. tab-set::
181+
182+
.. tab-item:: Local Testing
183+
184+
Please use the `tira-cli evaluate` command to test your evaluator locally by passing the ID of the dataset and the directory that contains the predictions for the dataset:
185+
186+
.. code:: bash
187+
188+
tira-cli evaluate --directory my-predictions --dataset DATASET-ID
189+
190+
If the evaluator works as expected, the output will look like this:
191+
192+
.. image:: run-evaluator-locally.png
193+
194+
195+
.. tab-item:: Test in TIRA.io
196+
197+
The simplest option to test that your evaluator works in TIRA.io is to upload the predictions so that the evaluator will run.
198+
199+
169200
------
170201

171202
.. note:: This is the previous version

0 commit comments

Comments
 (0)