Skip to content

Commit 923097c

Browse files
authored
GNN documentation (mlcommons#364)
MLCube documentation updates. - Adding information about new Graph Neural Network (GNN) benchmark. - Fixing various typos.
1 parent adb45e5 commit 923097c

File tree

5 files changed

+56
-4
lines changed

5 files changed

+56
-4
lines changed

docs/minified-benchmarks/bert.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ virtualenv -p python3 ./env && source ./env/bin/activate && pip install pip==24.
1313
git clone https://github.com/mlcommons/training && cd ./training/language_model/tensorflow/bert
1414
```
1515

16-
Go to mlcube directory and study what tasks MLCube implements.
16+
Go to the mlcube directory and study what tasks MLCube implements.
1717

1818
```shell
1919
cd ./mlcube
@@ -80,7 +80,7 @@ In the Google Cloud console, search for the Cloud TPU API page, then click Enabl
8080

8181
Then go to the virtual machine sections and select [TPUs](https://console.cloud.google.com/compute/tpus)
8282

83-
Select create TPU node, fill in all the needed parameters, the recommended TPU type in the [readme](../README.md#on-tpu-v3-128) is v3-128 and the recommended TPU software version is 2.4.0.
83+
Select create TPU node, fill in all the needed parameters, the recommended TPU type in the [readme](https://github.com/mlcommons/training/blob/3283fc35e68deb88f7197155964f7c3858705649/language_model/tensorflow/bert/README.md#on-tpu-v3-128) is v3-128 and the recommended TPU software version is 2.4.0.
8484

8585
The 3 most important parameters you need to remember are: `project name`, `TPU name`, and `TPU Zone`.
8686

docs/minified-benchmarks/gnn.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Graph Neural Network
2+
3+
The benchmark reference for Graph Neural Network can be found in this [link](https://github.com/mlcommons/training/tree/master/graph_neural_network), and here is the PR for the minified benchmark implementation: [link](https://github.com/mlcommons/training/pull/762).
4+
5+
## Project setup
6+
7+
An important requirement is that you must have Docker installed.
8+
9+
```bash
10+
# Create Python environment and install MLCube Docker runner
11+
virtualenv -p python3 ./env && source ./env/bin/activate && pip install pip==24.0 && pip install mlcube-docker
12+
# Fetch the implementation from GitHub
13+
git clone https://github.com/mlcommons/training && cd ./training
14+
git fetch origin pull/762/head:feature/mlcube_graph_nn && git checkout feature/mlcube_graph_nn
15+
cd ./graph_neural_network/mlcube
16+
```
17+
18+
Inside the mlcube directory run the following command to check implemented tasks.
19+
20+
```shell
21+
mlcube describe
22+
```
23+
24+
### MLCube tasks
25+
26+
Download dataset.
27+
28+
```shell
29+
mlcube run --task=download_data -Pdocker.build_strategy=always
30+
```
31+
32+
Process dataset.
33+
34+
```shell
35+
mlcube run --task=process_data -Pdocker.build_strategy=always
36+
```
37+
38+
Train GNN.
39+
40+
```shell
41+
mlcube run --task=train -Pdocker.build_strategy=always
42+
```
43+
44+
### Execute the complete pipeline
45+
46+
You can execute the complete pipeline with one single command.
47+
48+
```shell
49+
mlcube run --task=download_data,process_data,train -Pdocker.build_strategy=always
50+
```

docs/minified-benchmarks/introduction.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ A minified benchmark is a reduced version of a MLCommons training benchmark desi
66

77
The main advantages of these minified benchmarks are:
88

9-
- **Faster Execution**: Minified benchmarks are quicker to run (between 10 to 15 mintues), allowing for faster iteration and validation.
9+
- **Faster Execution**: Minified benchmarks are quicker to run (between 10 to 15 minutes), allowing for faster iteration and validation.
1010
- **Easier implementation**: By using MLCube users don't need to worry about installing everything from scratch.
1111
- **Reference preparation**: Minified benchmarks could be used as an introductory step for users interested in executing the MLCommons reference benchmarks.
1212

@@ -18,3 +18,4 @@ The main advantages of these minified benchmarks are:
1818
- [ResNet](resnet.md)
1919
- [Bert](bert.md)
2020
- [Object Detection](object-detection.md)
21+
- [Graph Neural Network](gnn.md)

docs/minified-benchmarks/object-detection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ It's also possible to execute the two tasks in one single instruction:
5858
mlcube run --task=download_demo,demo -Pdocker.build_strategy=always
5959
```
6060

61-
### Aditonal options
61+
### Additional options
6262

6363
Parameters defined at **mculbe/mlcube.yaml** could be overridden using: `--param=input`
6464

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ nav:
3434
- ResNet: minified-benchmarks/resnet.md
3535
- Bert: minified-benchmarks/bert.md
3636
- Object Detection: minified-benchmarks/object-detection.md
37+
- Graph Neural Network: minified-benchmarks/gnn.md
3738

3839
theme:
3940
features:

0 commit comments

Comments
 (0)