Skip to content

Commit

Permalink
Add watson how to's, add getting started info for watson and seldon (r…
Browse files Browse the repository at this point in the history
  • Loading branch information
jeff-phillips-18 authored and Chad Roberts committed Mar 30, 2021
1 parent 1d0a49b commit 03ce791
Show file tree
Hide file tree
Showing 18 changed files with 135 additions and 28 deletions.
5 changes: 3 additions & 2 deletions data/applications/seldon.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ spec:
kfdefApplications: [odhseldon]
route: ''
img: images/seldon.svg
docsLink: https://docs.seldon.io/
docsLink: https://deploy-v1-0.seldon.io/docs/
category: Self managed
support: third paty support
quickStart: ''
quickStart: 'seldon-deploy-model-canary'
getStartedLink: 'https://deploy.seldon.io/docs/getting-started'
3 changes: 2 additions & 1 deletion data/applications/watson-studio.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ spec:
docsLink: https://dataplatform.cloud.ibm.com/docs/content/wsj/landings/wsl.html
category: Self managed
support: third party support
quickStart: ''
quickStart: build-deploy-watson-model
getStartedLink: https://developer.ibm.com/series/cloud-pak-for-data-learning-path
10 changes: 10 additions & 0 deletions data/docs/watson-studio-cleanse-shape-visualize-how-to.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
metadata:
name: watson-studio-cleanse-shape-visualize-how-to
type: how-to
spec:
appName: watson-studio
displayName: How do I cleanse, shape, and visualize my data?
description: |-
Using data refinery to cleanse and shape tabular data
url: https://www.ibm.com/support/knowledgecenter/SSQNUZ_3.5.0/wsj/refinery/refining_data.html
durationMinutes: 10
10 changes: 10 additions & 0 deletions data/docs/watson-studio-create-connection-how-to.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
metadata:
name: watson-studio-create-connection-how-to
type: how-to
spec:
appName: watson-studio
displayName: How to create a connection to access data?
description: |-
Explains creating connections for various services across the platform.
url: https://www.ibm.com/support/knowledgecenter/SSQNUZ_3.5.0/cpd/access/connect-data-sources.html
durationMinutes: 10
10 changes: 10 additions & 0 deletions data/docs/watson-studio-create-deployment-space-how-to.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
metadata:
name: watson-studio-create-deployment-space-how-to
type: how-to
spec:
appName: watson-studio
displayName: How do I create a deployment space for deploying my model?
description: |-
Steps to create a deployment space
url: https://www.ibm.com/support/knowledgecenter/SSQNUZ_3.5.0/wsj/analyze-data/ml-spaces_local.html
durationMinutes: 10
10 changes: 10 additions & 0 deletions data/docs/watson-studio-create-notebook-how-to.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
metadata:
name: watson-studio-create-notebook-how-to
type: how-to
spec:
appName: watson-studio
displayName: How to create a notebook in Watson Studio?
description: |-
Create a basic Jupyter notebook in Watson Studio.
url: https://www.ibm.com/support/knowledgecenter/SSQNUZ_3.5.0/wsj/analyze-data/creating-notebooks.html
durationMinutes: 3
10 changes: 10 additions & 0 deletions data/docs/watson-studio-create-project-how-to.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
metadata:
name: watson-studio-create-project-how-to
type: how-to
spec:
appName: watson-studio
displayName: How to create a Project?
description: |-
Provides the steps to create an analytics project.
url: https://www.ibm.com/support/knowledgecenter/SSQNUZ_3.5.0/wsj/getting-started/projects.html
durationMinutes: 5
10 changes: 10 additions & 0 deletions data/docs/watson-studio-integrate-with-github-how-to.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
metadata:
name: watson-studio-integrate-with-github-how-to
type: how-to
spec:
appName: watson-studio
displayName: How do I create a project that's integrated with Github?
description: |-
How to add assets in the Git repository in a project
url: https://www.ibm.com/support/knowledgecenter/SSQNUZ_3.5.0/wsj/manage-data/git-integration.html
durationMinutes: 10
10 changes: 10 additions & 0 deletions data/docs/watson-studio-load-data-how-to.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
metadata:
name: watson-studio-load-data-how-to
type: how-to
spec:
appName: watson-studio
displayName: How to load data into Notebook?
description: |-
How to integrate data sources into a notebook
url: https://www.ibm.com/support/knowledgecenter/SSQNUZ_3.5.0/wsj/analyze-data/load-and-access-data.html
durationMinutes: 5
10 changes: 10 additions & 0 deletions data/docs/watson-studio-runtime-env-how-to.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
metadata:
name: watson-studio-runtime-env-how-to
type: how-to
spec:
appName: watson-studio
displayName: What are my choices for notebook runtime environments?
description: |-
How to configure a notebook runtime environment
url: https://www.ibm.com/support/knowledgecenter/SSQNUZ_3.5.0/wsj/analyze-data/notebook-environments.html
durationMinutes: 5
10 changes: 10 additions & 0 deletions data/docs/watson-studio-setup-openscale-how-to.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
metadata:
name: watson-studio-setup-openscale-how-to
type: how-to
spec:
appName: watson-studio
displayName: How do I set up Watson OpenScale?
description: |-
Track and measure outcomes from models with OpenScale
url: https://www.ibm.com/support/knowledgecenter/SSQNUZ_3.5.0/wsj/model/getting-started.html
durationMinutes: 10
4 changes: 4 additions & 0 deletions data/getting-started/seldon-deploy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
## Subscribe to the operator on Market place
- [https://marketplace.redhat.com/en-us/products/seldon-deploy](https://marketplace.redhat.com/en-us/products/seldon-deploy)
## Install the operator and validate
- [https://marketplace.redhat.com/en-us/documentation/operators](https://marketplace.redhat.com/en-us/documentation/operators)
4 changes: 4 additions & 0 deletions data/getting-started/watson-studio.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Subscribe to the operator on Market place
- [https://marketplace.redhat.com/en-us/products/ibm-watson-studio](https://marketplace.redhat.com/en-us/products/ibm-watson-studio)
# Install the operator and validate
- [https://marketplace.redhat.com/en-us/documentation/operators](https://marketplace.redhat.com/en-us/documentation/operators)
48 changes: 24 additions & 24 deletions data/quickstarts/deploy-watson-model-quickstart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ spec:
description: This quick start will walk you through importing a Notebook in Watson Studio, deploying a model, and monitoring with Open Scale.
introduction: |-
### This quick start will walk you through importing a Notebook in Watson Studio, deploying a model, and monitoring with Open Scale.
Build, run and manage AI models, and optimize decisions at scale across any cloud. IBM Watson Studio empowers you to operationalize AI anywhere as part of IBM Cloud Pak® for Data,
Build, run and manage AI models, and optimize decisions at scale across any cloud. IBM Watson Studio empowers you to operationalize AI anywhere as part of IBM Cloud Pak® for Data,
the IBM data and AI platform. Unite teams, simplify AI lifecycle management and accelerate time to value with an open, flexible multicloud architecture.
tasks:
Expand All @@ -17,53 +17,53 @@ spec:
### Create a Project
1. Choose Projects > View all projects from the menu and then click New project on the My Projects page.
2. Select Analytics project and click OK.
4. Click Create.
4. Click Create.
summary:
success: You have launched created a new project
failed: Try the steps again
- title: Accessing Data Locally
description: |-
### After you create a project, you add data assets to it so that you can work with data
1. Add a data file to your project from your local system
2. From your project’s Assets page, click Add to project > Data. 
3. In the Load pane that opens, browse for files or drag them onto the pane. 
summary:
success: The files are listed as data assets on the Assets page of your project.
failed: Try the steps again
2. From your project’s Assets page, click Add to project > Data.
3. In the Load pane that opens, browse for files or drag them onto the pane.
summary:
success: The files are listed as data assets on the Assets page of your project.
failed: Try the steps again
- title: Import a notebook into your project
description: |-
### After you have data assets you are ready to import a notebook
1. From your project, click Add to Project > Notebook.
2. On the New Notebook page, upload a notebook file from your file system, or a URL. 
3. Specify the runtime environment for the language you want to use (Python, R, or Scala). 
4. Click Create Notebook. 
summary:
success: The notebook opens in the Jupyter notebook editor.
2. On the New Notebook page, upload a notebook file from your file system, or a URL.
3. Specify the runtime environment for the language you want to use (Python, R, or Scala).
4. Click Create Notebook.
summary:
success: The notebook opens in the Jupyter notebook editor.
failed: Try the steps again
- title: Load data into your notebook
- title: Load data into your notebook
description: |-
### After you have a notebook created you can load data into the notebook
1. Click in an empty code cell in your notebook.
2. Click the Find and Add Data icon.
  3. Click Insert to code > pandas DataFrame right below the data file name.
3. Click Insert to code > pandas DataFrame right below the data file name.
4. Run the cell.
summary:
success: The data is now availble to load from the notebook.
summary:
success: The data is now availble to load from the notebook.
failed: Try the steps again
- title: Training an AutoAI model
- title: Training an AutoAI model
description: |-
### After you have a notebook with data loaded, you can start building a model
1. From the Assets page of your project, click Add to Project >AutoAI experiment.
2. Name your experiment, then click Create.
3. Upload or add from project the CSV file you will use to train the experiment.
4. Choose the prediction column.
5. Run the experiment.
summary:
success: You have trained a model.
summary:
success: You have trained a model.
failed: Try the steps again
- title: Save and Deploy a model
- title: Save and Deploy a model
description: |-
### After a model is trained, it can then be deployed
### After a model is trained, it can then be deployed
1. After the AutoAI experiment finishes training, choose the best performing pipeline and click Save as model.
2. A notification indicates the model is saved. Click the View in project link in the notification to open the model details page.
3. Create a deployment space, and then promote the model to the deployment space.
Expand All @@ -73,8 +73,8 @@ spec:
7. When the deployment is ready, click the name to view and test the deployment.
8. Click the Test tab and use the form interface to enter test values.
9. Click Predict to view the prediction.
summary:
success: You have deployed an AutoAI model.
failed: Try the steps again
summary:
success: You have deployed an AutoAI model.
failed: Try the steps again
conclusion: You are now able to import a notebook in Watson Studio, build, and deploy a model.
nextQuickStart: []
3 changes: 3 additions & 0 deletions frontend/src/pages/learningCenter/LearningCenter.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ const LearningCenter: React.FC = () => {
const updatedDoc = _.cloneDeep(odhDoc);
updatedDoc.spec.img = odhDoc.spec.img || odhApp.spec.img;
updatedDoc.spec.description = odhDoc.spec.description || odhApp.spec.description;
updatedDoc.spec.provider = odhDoc.spec.provider || odhApp.spec.provider;
return updatedDoc;
}
}
Expand All @@ -63,6 +64,8 @@ const LearningCenter: React.FC = () => {
type: ODHDocType.Documentation,
},
spec: {
appName: component.metadata.name,
provider: component.spec.provider,
url: component.spec.docsLink,
displayName: component.spec.displayName,
description: component.spec.description,
Expand Down
5 changes: 4 additions & 1 deletion frontend/src/pages/learningCenter/learningCenterUtils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,13 @@ export const doesDocAppMatch = (
const searchText = filterText.toLowerCase();
const {
metadata: { name },
spec: { displayName, description },
spec: { displayName, description, appName, provider },
} = odhDoc;
return (
!searchText ||
name.toLowerCase().includes(searchText) ||
(appName && appName.toLowerCase().includes(searchText)) ||
(provider && provider.toLowerCase().includes(searchText)) ||
displayName.toLowerCase().includes(searchText) ||
(description?.toLowerCase().includes(searchText) ?? false)
);
Expand Down
1 change: 1 addition & 0 deletions frontend/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ type ODHDoc = {
spec: {
displayName: string;
appName?: string;
provider?: string;
description: string;
url: string;
img?: string;
Expand Down

0 comments on commit 03ce791

Please sign in to comment.