New Client Method: Toggle Example as Done/Undone

[armandgurgu23]

Feature description

Given a project_id and an example_id, this new method would be able to update the Done / Undone status of an annotation sample in a Doccano project.

This feature would be tremendously useful to programatically mark annotations as Done when labels are submitted for an example. (rather than requiring annotators to handle this extra workload, which can be significant for large datasets)

c.c: @Hironsan @david-engelmann

[david-engelmann]

@armandgurgu23 Would the goal be to have the question marked as answered once it's been viewed?

[armandgurgu23]

@david-engelmann Good question. In my pitch above I was only envisioning having a method to toggle Done/Undone for an example.

The condition on which to update the Done/Undone status could be left to the discretion of the user.

My example above is one possible condition where having a method to toggle Done/Undone can help speed up annotations. In this usecase an annotator that has already viewed an example and marked it with a label also needs to make sure to mark this as Done. If such a utility method existed, I could use the Client API to automatically mark annotation examples as Done based on whether the annotator submitted a label, thereby saving time for the annotator.

[david-engelmann]

@armandgurgu23 You should be able to accomplish this with the update_example_state method. It will toggle between the Done/Undone status

doccano_client.update_example_state(project_id=project_id, example_id=example_id)

[armandgurgu23]

@david-engelmann Good suggestion I will test out update_example_state for my usecase and get back to you if it worked!