Interactive tool interface

.streamlit/config.toml

@@ -0,0 +1,4 @@
+[runner]
+
+postScriptGC = false
+magicEnabled = false

docs/conf.py

@@ -259,4 +259,6 @@ def linkcode_resolve(domain, info):
     ("py:class", "_regex.Pattern"),
     ("py:class", "urllib3.util.retry.Retry"),
     ("py:class", "gliner.GLiNER"),
+    # no sphinx for streamlit
+    ("py:class", "streamlit.delta_generator.DeltaGenerator"),
 ]

docs/index.rst

@@ -18,6 +18,7 @@ Welcome to Kazu's documentation!
    Kazu Data Model <datamodel>
    Visualising results in Label Studio <label_studio_integration>
    The OntologyParser <ontology_parser>
+   The Kazu Resource Tool <kazu_resource_tool>
    Curating a knowledge base for NER and Linking <curating_a_knowledgebase>
    Scaling with Ray <scaling_kazu>
    Kazu as a WebService <kazu_webservice>

docs/kazu_resource_tool.rst

@@ -0,0 +1,21 @@
+.. _kazu_resource_tool:
+
+The Kazu Resource Tool
+================================
+
+The Kazu Resource Tool is a command line tool that can be used to find and resolve the various issues that can arise when working with :class:`.OntologyStringResource`\s in a Kazu project,
+as decribed at the end of the :ref:`ontology_parser` section.
+
+It's main purpose is to help you find and fix issues with your resource files, and to help you understand how your resources are configured.
+
+First, ensure that ``KAZU_MODEL_PACK`` is set in your environment, as described in the :ref:`quickstart` section.
+
+Now, from the root of your Kazu project, you can run the Kazu Resource Tool with the following command:
+
+.. code-block:: console
+
+   $ streamlit run krt/Introduction.py
+
+This will start a Streamlit server, which will allow you to interact with the Kazu Resource Tool in your browser.
+
+Further instructions are described in the Streamlit app itself.

docs/ontology_parser.rst

@@ -273,7 +273,7 @@ The flow of an ontology parser to handling the underlying strings is as follows:
    a :class:`.OntologyResourceSetCompleteReport`,  describing the differences between the old and the new versions. The results
    are then used to supplement the existing :class:`.OntologyStringResource`\s for the new version.
 
-We are working on a simple tool to guide the user through each of these stages, which will be available in a future release.
+To assist with the above, Kazu provides a simple Streamlit tool :ref:`kazu_resource_tool` to help with the curation process.
 
 To explore the other capabilities of the :class:`.OntologyParser`, such as synonym generation and ID filtering, please
 refer to the API documentation.