Skip to content

Commit

Permalink
Adds markdown visualization example and image (#926)
Browse files Browse the repository at this point in the history
* Adds example markdown code and image to docs

* Adds comments

* Update image
  • Loading branch information
rileyjbauer authored and k8s-ci-robot committed Jul 12, 2019
1 parent b01ed98 commit 0b32371
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 2 deletions.
Binary file added content/docs/images/markdown-output.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 25 additions & 2 deletions content/docs/pipelines/sdk/output-viewer.md
Expand Up @@ -231,8 +231,31 @@ The viewer can read the Markdown data from the following locations:
* Markdown code in a remote file, at a path specified in the `source` field.
The `storage` field can contain any value except `inline`.

**Example:** *None available. See issue [kubeflow/website
#723](https://github.com/kubeflow/website/issues/723).*
**Example:**
```Python
metadata = {
'outputs' : [
# Markdown that is hardcoded inline
{
'storage': 'inline',
'source': '# Inline Markdown\n[A link](https://www.kubeflow.org/)',
'type': 'markdown',
},
# Markdown that is read from a file
{
'source': 'gs://your_project/your_bucket/your_markdown_file',
'type': 'markdown',
}]
}
with file_io.FileIO('/mlpipeline-ui-metadata.json', 'w') as f:
json.dump(metadata, f)
```

**Visualization on the Kubeflow Pipelines UI:**

<img src="/docs/images/markdown-output.png"
alt="Markdown visualization from a pipeline component"
class="mt-3 mb-3 border border-info rounded">

### ROC curve

Expand Down

0 comments on commit 0b32371

Please sign in to comment.