Skip to content

docs: Add better CE intro #189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alhendrickson merged 2 commits into from
Oct 28, 2026
Merged

docs: Add better CE intro #189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
91c78ce
docs: Add better CE intro
alhendrickson Oct 28, 2026
559106a
docs: Add better CE intro
alhendrickson Oct 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion docs/docs/cogstack-ce/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@ CogStack CE aims to show what is possible with the open source CogStack products

It is installed with a one line command, and comes preconfigured with default data sets, configurations, and example dashboards already setup for you. It is built to run in Kubernetes, from local instances using Minikube, and scale up to production clusters and managed cloud environments.


!!! tip AI Model Access
The Cogstack CE runs with a basic open source AI model by default.

If you have a NIH / UMLS API key, you will be able to get a better performing model for free by following these steps: [CogStack Models](https://docs.cogstack.org/en/latest/medcat/medcat/docs/#available-models)

For access to the proprietary best performing models trained on real world clinical datasets, contact us!


## Where to start

1. [Quickstart](./tutorial/quickstart-installation.md) for the installation
Expand All @@ -22,6 +31,7 @@ It combines model serving, de-identification, model training, notebook-based ana
| MedCAT Trainer | Train, tune, and manage MedCAT models. |
| JupyterHub | Run notebooks for experimentation and end-to-end workflows. |
| OpenSearch + Dashboards | Index, search, and explore operational or NLP data. |
| OCR service | Run Optical Character Recognition to parse scanned docs into text |

![CogStack CE Architecture](./assets/cogstack-ce-architecture.png)

Expand All @@ -30,7 +40,8 @@ It combines model serving, de-identification, model training, notebook-based ana

For the full installation reference, deployment instructions, and customizations, see:

- [Deployment](../platform/deployment/index.md)
- [Quickstart](./tutorial/quickstart-installation.md) for the installation
- [Deployment](../platform/deployment/index.md) for in depth deployment options including how to run on the cloud
- [CogStack CE Helm chart (install + customization)](../platform/deployment/helm/charts/cogstack-ce-helm.md)

## Models
Expand Down
6 changes: 6 additions & 0 deletions docs/docs/cogstack-ce/tutorial/quickstart-installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ The install should take around 15 minutes, and by the end of this tutorial you w
- A Kubernetes cluster
- Helm 3+

You will need a running kubernetes cluster and helm for this to work.

One easy option to get a local kubernetes is to use minikube, see https://minikube.sigs.k8s.io/docs/start/ for a guide. If you're running docker desktop, it also makes it easy to run one.

Helm can be installed by following https://helm.sh/docs/intro/install/ . To directly quote that page if you just want to be quick, "Yes, you can `curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-4 | bash` if you want to live on the edge."

## 1. Install CogStack CE

Run:
Expand Down
Loading