Skip to content

Commit

Permalink
Merge pull request #67 from STRIDES/kao_check_links
Browse files Browse the repository at this point in the history
Added link check workflow
  • Loading branch information
dchesterNIH authored Jan 3, 2024
2 parents 53b18a2 + af25c88 commit 98e82c1
Show file tree
Hide file tree
Showing 8 changed files with 109 additions and 14 deletions.
39 changes: 39 additions & 0 deletions .github/workflows/check-jupyter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Test Notebooks

on:
push:
branches:
- '*'
pull_request:
branches:
- '*'

jobs:
test-notebooks:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v2

- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: 3.8

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install jupyter nbformat nbconvert
- name: Execute Notebooks
run: |
find tutorials/notebooks/* -name '*.ipynb' -exec jupyter nbconvert --to notebook --execute {} +
- name: Check for errors
run: |
if [ $? -ne 0 ]; then
echo "Notebook execution failed."
exit 1
fi
28 changes: 28 additions & 0 deletions .github/workflows/check_links.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Check Links

on:
push:
branches:
- '*'
pull_request:
branches:
- '*'
jobs:
check-links:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v2

- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: 16

- name: Install dependencies
run: |
npm install -g markdown-link-check
- name: Check links in Markdown files
run: find . -name '*.md' -print0 | xargs -0 -n1 markdown-link-check -q -c .markdown-link-check.json
26 changes: 26 additions & 0 deletions .markdown-link-check.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"ignorePatterns": [
{
"pattern": "^#"
},
{
"pattern": "^https://platform.openai.com/docs/guides/"
}
],
"replacementPatterns": [
{
"pattern": "^/docs",
"replacement": "https://github.com/STRIDES/NIHCloudLabAzure/tree/main/docs"
},
{
"pattern": "^/tutorials",
"replacement": "https://github.com/STRIDES/NIHCloudLabAzure/tree/main/tutorials"
}

],
"timeout": "20s",
"retryOn429": true,
"retryCount": 5,
"fallbackRetryDelay": "30s",
"aliveStatusCodes": [200, 206]
}
18 changes: 9 additions & 9 deletions docs/Using_The_Azure_Price_Calculator.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,32 +59,32 @@ Products are available but probably not used in Azure Cloud lab.
### Containers
The Containers tab displays tiles showing the options for Azure based containers.

![Screenshot of Container Products](/docs/images/(9_container_products.png)
![Screenshot of Container Products](/docs/images/9_container_products.png)

### Databases
The Databases tab displays tiles listing your Azure database options.

![Screenshot of Database Products](/docs/images/(10_db_products.png)
![Screenshot of Database Products](/docs/images/10_db_products.png)

### Analytics
This tab displays the available Azure based analytic tools.

![Screenshot of Analytics Products](/docs/images/(11_analytics_products.png)
![Screenshot of Analytics Products](/docs/images/11_analytics_products.png)

### AI + machine learning
The AI + machine learning tab displays tiles of of available products related to the title.

![Screenshot of AIML Products](/docs/images/(12_AI_products.png)
![Screenshot of AIML Products](/docs/images/12_AI_products.png)

### Internet of Things
The IOT tab displays products related to IOT operations plus some analytics and machine learning products.

![Screenshot of AIML Products](/docs/images/(13_IOT_products.png)
![Screenshot of AIML Products](/docs/images/13_IOT_products.png)

### Integration
This tab displays tiles of products relating to integrating with operations outside of the Azure Cloud.

![Screenshot of Integration Products](/docs/images/(14_integration_products.png)
![Screenshot of Integration Products](/docs/images/14_integration_products.png)

### Identity
Products are available but probably not used in Azure Cloud lab.
Expand Down Expand Up @@ -115,15 +115,15 @@ Products aavailable but probably not used in Azure Cloud lab.
The Examples tab is exactly what it describes. It shows you six examples of figuring the total cost of various products that you would need for your projects.
If we choose Real-time analysis we are presented with a project drawing with a listing of the products that will be used.

![Screenshot of RealTimeAnaltyics](/docs/images/(15_RT_Analytics.png)
![Screenshot of RealTimeAnaltyics](/docs/images/15_RT_Analytics.png)

If you click the Add to Estimate button you will then see a breakdown of each item's cost. Please note the number of instances and the default number of hours used to generate the estimate.

![Screenshot of RealTimeAnaltyics](/docs/images/(16_get_estimate.png)
![Screenshot of RealTimeAnaltyics](/docs/images/16_get_estimate.png)

Now, if we do the same steps with the example above as we did under calculating costs by removing items and reducing hours. We can then bring the costs down to something that is under the Cloud Lab monthly budget.

![Screenshot of RealTimeAnaltyics](/docs/images/(17_revise_estimate.png)
![Screenshot of RealTimeAnaltyics](/docs/images/17_revise_estimate.png)

## Saved Estimates Tab
Just what it implies. You will find any previously saved estimates under this tab.
Expand Down
2 changes: 1 addition & 1 deletion docs/billing_and_cost_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ You can add a tag to pretty much any resource but let's look at a few examples.

The left panel on the subscription home screen lists your options for managing costs within your subscription. Overview gives you a snapshot of your current and predicted future spending rates.

![Billing Dashboard](/docs/images/1_billing_dashboard_image)
![Billing Dashboard](/docs/images/1_billing_dashboard_image.png)

Under **Cost Management** there are three tools to help you manage costs, Cost analysis, Cost alerts, and Budgets. Additionally there is one tool called Advisor recommendations to help you configure your Subscription, and resources, in the most cost effective manners.

Expand Down
2 changes: 1 addition & 1 deletion tutorials/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Single-cell RNA sequencing (scRNA-seq) is a technique that enables the analysis

## **Long Read Sequence Analysis** <a name="long"></a>
Long read DNA sequence analysis involves analyzing sequencing reads typically longer than 10 thousand base pairs (bp) in length, compared with short read sequencing where reads are about 150 bp in length.
Oxford Nanopore has a pretty complete offering of notebook tutorials for handling long read data to do a variety of things including variant calling, RNAseq, Sars-Cov-2 analysis and much more. Access the notebooks [here](https://labs.epi2me.io/nbindex/) and on [GitHub](https://github.com/epi2me-labs/tutorials/tree/master/tutorials). These notebooks expect you are running locally and accessing the epi2me notebook server. To run them in Cloud Lab, skip the first cell that connects to the server and then the rest of the notebook should run correctly, with a few tweaks. Oxford Nanopore also offers a host of [Nextflow workflows](https://labs.epi2me.io/wfindex/) that will allow you to run a variety of long read pipelines.
Oxford Nanopore has a pretty complete offering of notebook tutorials for handling long read data to do a variety of things including variant calling, RNAseq, Sars-Cov-2 analysis and much more. Access the notebooks [here](https://labs.epi2me.io/nbindex/) and on [GitHub](https://github.com/epi2me-labs). These notebooks expect you are running locally and accessing the epi2me notebook server. To run them in Cloud Lab, skip the first cell that connects to the server and then the rest of the notebook should run correctly, with a few tweaks. Oxford Nanopore also offers a host of [Nextflow workflows](https://labs.epi2me.io/wfindex/) that will allow you to run a variety of long read pipelines.

## **Open Data** <a name="open"></a>
These publicly available datasets can save you time on data discovery and preparation by being curated and ready to use in your workflows.
Expand Down
2 changes: 1 addition & 1 deletion tutorials/notebooks/Azure_Open_AI/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Now we will look at [adding and querying over your own data](#Upload-your-own-da

If you have not already (A) Navigate to the Chat Playground. Here we will walk through the various options available to you. First, you can specify a `System Message` which tells the model what context with which to respond to inquiries. To modify this, (B) select `System message`, then (B) input a [System Message](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/system-message#define-the-models-profile-capabilities-and-limitations-for-your-scenario) in the prompt box, then (D) click **Save**.

On the next tab over, you can (A) add your own data, which we dive into in the [next section](Upload-your-own-data-and-query-over-it). In the middle of the page is where you actually interact with the model (B) through the chat prompts. Always (C) clear the chat after each session.
On the next tab over, you can (A) add your own data, which we dive into in the [next section](#Upload-your-own-data-and-query-over-it). In the middle of the page is where you actually interact with the model (B) through the chat prompts. Always (C) clear the chat after each session.

![add your own data](/docs/images/18_add_custom_data.png)

Expand Down
6 changes: 4 additions & 2 deletions tutorials/notebooks/SpleenLiverSegmentation/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# Spleen Segmentation with Liver Example using NVIDIA Models and MONAI
_We have put together a training example that segments the Spleen in 3D CT Images. At the end is an example of combining both the Spleen model and the Liver model._

*Nvidia has changed some of the models used in this tutorial and it may crash, if you have issues, try commenting out the liver model, we are working on a patch*

## Introduction
Two pre-trained models from NVIDIA are used in this training, a Spleen model and Liver.
The Spleen model is additionally retrained on the medical decathlon spleen dataset: [http://medicaldecathlon.com/](http://medicaldecathlon.com/)
Data is not necessary to be downloaded to run the notebook. The notebook downloads the data during it's run.
The notebook uses the Python package [MONAI](https://monai.io/), the Medical Open Network for Artificial Intelligence.

- Spleen Model - [clara_pt_spleen_ct_segmentation_V2](https://catalog.ngc.nvidia.com/orgs/nvidia/teams/med/models/clara_pt_spleen_ct_segmentation)
- Liver Model - [clara_pt_liver_and_tumor_ct_segmentation_V1](https://catalog.ngc.nvidia.com/orgs/nvidia/teams/med/models/clara_pt_liver_and_tumor_ct_segmentation)
- Spleen Model - [clara_pt_spleen_ct_segmentation_V2](https://catalog.ngc.nvidia.com/orgs/nvidia/teams/monaitoolkit/models/monai_spleen_ct_segmentation)
- Liver Model - [clara_pt_liver_and_tumor_ct_segmentation_V1]()

## Outcomes
After following along with this notebook the user will be familiar with:
Expand Down

0 comments on commit 98e82c1

Please sign in to comment.