diff --git a/docs/docs/assets/tour/anoncat-service-demo.webm b/docs/docs/assets/tour/anoncat-service-demo.webm new file mode 100644 index 0000000..afa1f06 Binary files /dev/null and b/docs/docs/assets/tour/anoncat-service-demo.webm differ diff --git a/docs/docs/assets/tour/jupyterhub-demo.webm b/docs/docs/assets/tour/jupyterhub-demo.webm new file mode 100644 index 0000000..aa4f610 Binary files /dev/null and b/docs/docs/assets/tour/jupyterhub-demo.webm differ diff --git a/docs/docs/assets/tour/medcat-service-demo.webm b/docs/docs/assets/tour/medcat-service-demo.webm new file mode 100644 index 0000000..7ce8f08 Binary files /dev/null and b/docs/docs/assets/tour/medcat-service-demo.webm differ diff --git a/docs/docs/assets/tour/medcat-trainer-demo.webm b/docs/docs/assets/tour/medcat-trainer-demo.webm new file mode 100644 index 0000000..eca6d2b Binary files /dev/null and b/docs/docs/assets/tour/medcat-trainer-demo.webm differ diff --git a/docs/docs/assets/tour/opensearch-dashboard-demo.webm b/docs/docs/assets/tour/opensearch-dashboard-demo.webm new file mode 100644 index 0000000..301c09f Binary files /dev/null and b/docs/docs/assets/tour/opensearch-dashboard-demo.webm differ diff --git a/docs/docs/cogstack-ce/_index.md b/docs/docs/cogstack-ce/_index.md index b909388..892c14e 100644 --- a/docs/docs/cogstack-ce/_index.md +++ b/docs/docs/cogstack-ce/_index.md @@ -20,8 +20,8 @@ It combines model serving, de-identification, model training, notebook-based ana ## Where to start -1. [Tutorial: Quickstart](./tutorial/quickstart-installation.md) -2. [Tutorial: End To End Tutorial](./tutorial/end-to-end-jupyterhub.md) +1. [Quickstart](./tutorial/quickstart-installation.md) for the installation +2. [Product Tour](./tutorial/end-to-end-jupyterhub.md) ## Installation and customization (reference) diff --git a/docs/docs/cogstack-ce/product-tour.md b/docs/docs/cogstack-ce/product-tour.md new file mode 100644 index 0000000..8a6cee9 --- /dev/null +++ b/docs/docs/cogstack-ce/product-tour.md @@ -0,0 +1,94 @@ +# CogStack CE Product Tour + +This page gives an overview of the deployed apps in the CogStack Helm chart (Community Edition). + +In this tour, we will: + +- Open each app in the browser using the local port-forwarded URL. +- Test that the applications are up and running +- See some basic features of each app +- Point you to the relevant documentation for next steps. + +## Before you start + +!!! tip + To follow allong with this tour, you should have the cogstack CE installed and local port-forwarding running. + + If needed, re-run this command to port-forward again: + + ```sh + helm get notes cogstack | bash + ``` + + Running this command will also print all of the URLs for the apps. To follow along with the rest of this tour, you can click the links in your terminal window to open the apps. + +## Product Tour + +### Medcat Service + +Open the MedCAT UI at `http://127.0.0.1:5000`, load the sample text, and click Annotate. The concepts and annotations will appear in the results panel on the right. + +For a walkthrough of this service in the CogStack platform docs, see [MedCAT service tutorial](../platform/cogstack-ai/medcat-service-tutorial.ipynb). + +To learn more about MedCAT and related services, see [CogStack NLP on GitHub](https://github.com/CogStack/cogstack-nlp). + + + + +By default the cogstack community edition uses a tiny model that only learned one concept, so it wont give very good results if you try with other inputs. Check the medcat documentation for access to public models, or contact us if you want access to the best performing private models. + +### AnonCAT Service + +Open the AnonCAT UI at `http://127.0.0.1:5001`, load the sample, and click Annotate. The processed/anonymised output will be shown on the right. + +For a walkthrough of this service in the CogStack platform docs, see [MedCAT service tutorial](../platform/cogstack-ai/medcat-service-tutorial.ipynb). + +To learn more about AnonCAT and related services, see [CogStack NLP on GitHub](https://github.com/CogStack/cogstack-nlp). + + + +### MedCAT Trainer + +Open MedCAT Trainer at `http://127.0.0.1:8080` and log in with your credentials. You should see it provisioned with two projects corresponding to the two services; open either project to view the documents and start annotating. + +For a deeper guide to projects and annotation workflows, see the [MedCATtrainer documentation](https://docs.cogstack.org/projects/medcat-trainer/en/latest/). + + + +### JupyterHub + +Open JupyterHub at `http://127.0.0.1:8000` and log in with your credentials, then wait for your server to start. Open the demo notebook and run it to see the example workflow. + +For the end-to-end walkthrough in these docs, see [End-to-end JupyterHub](tutorial/end-to-end-jupyterhub.md). + +For more details on the JupyterHub setup used here, see [CogStack Jupyter Hub on GitHub](https://github.com/CogStack/cogstack-jupyter-hub/). + +!!! warning + + If this is the first time opening jupyterhub, it might take a while starting up your user container. This is mostly spent downloading the cogstack-singleuser + + + +### OpenSearch Dashboards + +Open OpenSearch Dashboards at `http://127.0.0.1:5601` and log in with your credentials. Browse to Dashboards and open the sample dashboard to explore the visualisations. + +By default in the cogstack community edition, it will generate and load test data and a sample dashboard. + + + +## Summary and Next Steps + +You've now tried out the UIs of each deployed app in the cogstack community edition. + +Next you can try using them in code by following the end-to-end tutorial at [End-to-end JupyterHub](./tutorial/end-to-end-jupyterhub.md). \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 8b9891a..eceeb7a 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -38,6 +38,7 @@ nav: - CogStack Community Edition: - Overview: cogstack-ce/_index.md - Quickstart: cogstack-ce/tutorial/quickstart-installation.md + - Product Tour: cogstack-ce/product-tour.md - Tutorials: - Using JupyterHub: cogstack-ce/tutorial/end-to-end-jupyterhub.md - End To End Tutorial: cogstack-ce/tutorial/medcat-opensearch-e2e.ipynb