-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add CLI Notebook examples in the doc (#1087)
*Issue #, if available:* *Description of changes:* By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice. --------- Co-authored-by: Xiang Song <[email protected]>
- Loading branch information
1 parent
19fac3b
commit 3a21067
Showing
3 changed files
with
34 additions
and
12 deletions.
There are no files selected for viewing
This file contains 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 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,28 @@ | ||
.. _cli-examples: | ||
|
||
GraphStorm CLI Examples | ||
======================== | ||
|
||
GraphStorm provides Command Line Interfaces (CLIs) for graph data | ||
preparation and GML model training and inference. To help users to | ||
quickly onboard GraphStorm CLIs, we provide a set of Jupyter | ||
notebooks as examples. | ||
|
||
.. note:: All runnable Jupyter notebooks can be downloaded from the `GraphStorm Github repository <https://github.com/awslabs/graphstorm/tree/main/docs/source/cli/notebooks>`_. | ||
|
||
These notebooks all use the same ACM data as discussed in | ||
the :ref:`User Your Own Data Tutorial<use-own-data>`. | ||
Users can follow the `Notebook 0: Data Preparation <https://github.com/awslabs/graphstorm/blob/main/docs/source/api/notebooks/Notebook_0_Data_Prepare.ipynb>`_ | ||
to explore the details of ACM data preparation. | ||
|
||
The `CLI Notebook: Use GraphStorm CLI for Multi-task Learning <https://github.com/awslabs/graphstorm/blob/main/docs/source/cli/notebooks/Notebook_CLI_MT.ipynb>`_ provides | ||
an example that demonstrates how to run multi-task GNN model | ||
training and inference with GraphStorm CLIs. The training | ||
tasks include link prediction and node feature reconstruction. | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:titlesonly: | ||
|
||
Notebook_CLI_MT | ||
|
This file contains 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