Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add tutorial notebooks with link to run on colab #234

Merged
merged 7 commits into from
Jul 15, 2024
Merged

Add tutorial notebooks with link to run on colab #234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
aeeca10
start tutorial notebook
rishabh-ranjan Jul 9, 2024
a264f61
start tutorial notebook
rishabh-ranjan Jul 9, 2024
b96d1e3
add tutorial notebooks
rishabh-ranjan Jul 10, 2024
b674705
remove demo because we have colab tutorials now
rishabh-ranjan Jul 10, 2024
e871247
Merge branch 'main' into rr-tutorials
rishabh-ranjan Jul 10, 2024
a1f29e7
update readme
rishabh-ranjan Jul 10, 2024
eb685e7
Merge branch 'main' into rr-tutorials
joshr17 Jul 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,10 +159,10 @@ task.evaluate(val_pred, val_table)
# Tutorials
To get started with RelBench, we provide some helpful Colab notebook tutorials. These tutorials cover (i) how to load data using RelBench, focusing on providing users with the understanding of RelBench data logic needed to use RelBench data freely with any desired ML models, and (ii) training a GNN predictive model to solve tasks in RelBench. Please refer to the code for more detailed documentation.

| Name | Colab | Description |
|-------|-------|---------------------------------------------------------|
| Loading Data | [<img align="center" src="https://colab.research.google.com/assets/colab-badge.svg" />](https://colab.research.google.com/drive/1PAOktBqh_3QzgAKi53F4JbQxoOuBsUBY?usp=sharing) | How to load and explore RelBench data
| Training models | [<img align="center" src="https://colab.research.google.com/assets/colab-badge.svg" />](https://colab.research.google.com/drive/1_z0aKcs5XndEacX1eob6csDuR4DYhGQU?usp=sharing)| Train your first GNN-based model on RelBench. |
| Name | Notebook | Try on Colab | Description |
|-------|----------|--------------|---------------------------------------------------------|
| Loading Data | [load_data.ipynb](tutorials/load_data.ipynb) | [<img align="center" src="https://colab.research.google.com/assets/colab-badge.svg" />](https://colab.research.google.com/github/snap-stanford/relbench/blob/main/tutorials/load_data.ipynb) | How to load and explore RelBench data
| Training models | [train_model.ipynb](tutorials/train_model.ipynb) | [<img align="center" src="https://colab.research.google.com/assets/colab-badge.svg" />](https://colab.research.google.com/github/snap-stanford/relbench/blob/main/tutorials/train_model.ipynb)| Train your first GNN-based model on RelBench. |



Expand Down
Loading
Loading