-
Notifications
You must be signed in to change notification settings - Fork 12
docs(medcat): Add Medcat Tutorials into public documentation page #417
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.
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
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
9575ecb
docs: Build Medcat Tutorials with Mkdocs
alhendrickson b32a7f6
docs: Build Medcat Tutorials with Mkdocs
alhendrickson 8a83791
docs(medcat): Add medcat tutorials into public documentation page
alhendrickson 4452ead
docs(medcat): Add medcat tutorials into public documentation page
alhendrickson c9cfa42
docs(medcat): Add medcat tutorials into public documentation page - f…
alhendrickson bc72c55
docs(medcat-tutorial): Remove readme duplication
alhendrickson b098f27
docs(medcat-tutorial): Remove readme duplication
alhendrickson ddc409a
docs(medcat-tutorial): Refactor nav
alhendrickson 5f38919
docs(medcat-tutorial): Refactor doc
alhendrickson 1891543
docs: Add links to the tutorials on medcat
alhendrickson baf8aef
docs: Add links to the tutorials on medcat - fix typo
alhendrickson File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| # yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json | ||
| site_name: MedCAT Tutorials | ||
| site_url: https://docs.cogstack.org/ | ||
|
|
||
| theme: | ||
| name: material | ||
| favicon: _static/img/cat-logo.svg | ||
| logo: _static/img/cat-logo.svg | ||
| icon: | ||
| logo: _static/img/cat-logo.svg | ||
| palette: | ||
| primary: white | ||
|
|
||
| features: | ||
| - navigation.tabs | ||
| - navigation.sections | ||
| - navigation.top | ||
| - navigation.indexes | ||
| - navigation.tracking | ||
| - navigation.footer | ||
| - header.autohide | ||
| - content.tooltips | ||
| - search.highlight | ||
| - search.share | ||
| - search.suggest | ||
| - toc.follow | ||
| - attr_list | ||
|
|
||
| repo_url: https://github.com/CogStack/cogstack-nlp | ||
| repo_name: cogstack-nlp | ||
|
|
||
| docs_dir: notebooks | ||
|
|
||
| nav: | ||
| - Home: index.md | ||
| - Introductory Tutorials: | ||
| - Basic: | ||
| - README: introductory/basic/README.md | ||
| - 1. Build a Concept Database and a Vocabulary: introductory/basic/1._Build_a_Concept_Database_and_a_Vocabulary.ipynb | ||
| - 2. Unsupervised training on model: introductory/basic/2._Unsupervised_training_on_model.ipynb | ||
| - 3. Supervised training on model: introductory/basic/3._Supervised_training_on_model.ipynb | ||
| - 4. Evaluating performance on dataset: introductory/basic/4._Evaluating_performance_on_dataset.ipynb | ||
| - MetaCAT: | ||
| - README: introductory/meta/README.md | ||
| - 1. Add a MetaCat to a Model: introductory/meta/1._Add_a_MetaCat_to_a_Model.ipynb | ||
| - RelCAT: | ||
| - 1. Supervised Training Relation Extraction: introductory/relcat/1._Supervised_Training_Relation_Extraction.ipynb | ||
| - 2. Infering relations from annotations with Relation toolkit: introductory/relcat/2._Infering_relations_from_annotations_with_Relation_toolkit.ipynb | ||
|
|
||
| - Advanced Tutorials: | ||
| - 1. Creating and using a custom tokenizer: advanced/1._Creating_and_using_a_custom_tokenizer.ipynb | ||
| - 2. Create and use component: advanced/2._Create_and_use_component.ipynb | ||
| - Custom Components: | ||
| - README: introductory/custom/README.md | ||
| - 1. Create Modelpack with 2step linker: introductory/custom/1._Create_Modelpack_with_2step_linker.ipynb | ||
| - Migration: | ||
| - README: introductory/migration/README.md | ||
| - 1. Migrate v1 model to v2: introductory/migration/1._Migrate_v1_model_to_v2.ipynb | ||
|
|
||
| plugins: | ||
| - search | ||
| - termynal | ||
| - autorefs # Resolves cross-refs from mkdocstrings so type links work across pages | ||
| - mkdocs-jupyter: | ||
| ignore_h1_titles: True | ||
|
|
||
| markdown_extensions: | ||
| - admonition | ||
| - attr_list | ||
| - pymdownx.details | ||
| - pymdownx.superfences | ||
| - pymdownx.emoji: | ||
| emoji_index: !!python/name:material.extensions.emoji.twemoji | ||
| emoji_generator: !!python/name:material.extensions.emoji.to_svg | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| # MedCAT Tutorials | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Just another comment that I think we need a link to the tutorials in the docs page. Otherwise someone looking at the repo will have no idea where to go from here. |
||
|
|
||
| The MedCAT Tutorials provide an interactive learning path for using MedCAT. | ||
|
|
||
| These tutorials are aimed at developers and / or people creating their own models. | ||
| For every day usage (e.g inference) the [medcat-scripts](https://github.com/CogStack/cogstack-nlp/tree/main/medcat-scripts) portion would probably be more useful. | ||
|
|
||
| ## Learning Path | ||
|
|
||
| Get started by going to the [basic tutorials](introductory/basic/). Here you will learn about Concept Databases, Vocabularies, and perform supervised and unsupervised training. | ||
|
|
||
| After that you can continue to see the other features of medcat, such as configuring MetaCAT and RelCAT. | ||
|
|
||
| Finally you can look at advanced tutorials where you will dig into the internals of MedCAT. | ||
|
|
||
| ## Interactive Usage | ||
|
|
||
| !!! tip | ||
|
|
||
| These tutorials are written as real, executable code in jupyter notebooks. The version on docs.cogstack.org is read only, but you could instead choose to follow along and run the code as you go. | ||
|
|
||
| To get set up to run the tutorials interactively, clone the repo and install the tutorial dependencies. | ||
|
|
||
| ```bash | ||
| git clone https://github.com/CogStack/cogstack-nlp.git | ||
| cd cogstack-nlp/medcat-v2-tutorials | ||
|
|
||
| python -m venv .venv | ||
| source .venv/bin/activate | ||
| pip install -r requirements.txt | ||
| ``` | ||
| You can now open the notebook in vscode and run the tutorials. Alternatively you could use `pip install jupyter` and run `jupyter lab` to do this on the command line. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| [project] | ||
| name = "medcat-v2-documentation" | ||
| version = "0.1.0" | ||
| description = "MedCAT v2 Documentation" | ||
| requires-python = ">=3.10" | ||
| dependencies = [ | ||
| "mkdocs-api-autonav>=0.4.0", | ||
| "mkdocs-material>=9.7.0", | ||
| "mkdocstrings-python>=2.0.3", | ||
| "termynal>=0.13.1", | ||
| "mkdocs-jupyter>=0.26.1", | ||
| ] | ||
|
|
||
| [project.optional-dependencies] | ||
| dev = [ | ||
| "ruff>=0.12.11", | ||
| ] | ||
|
|
||
| [tool.ruff] | ||
| line-length = 120 |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.