From ce696cc64a740f3537dec3dba5226bed2ab05338 Mon Sep 17 00:00:00 2001 From: kexinhuang12345 Date: Sun, 26 Nov 2023 23:47:25 -0800 Subject: [PATCH] update readme with demos and testing badge --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 463a4af3..b8a12c0b 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ [![website](https://img.shields.io/badge/website-live-brightgreen)](https://relbench.stanford.edu) [![PyPI version](https://badge.fury.io/py/relbench.svg)](https://badge.fury.io/py/relbench) +[![Testing Status](https://github.com/snap-stanford/relbench/actions/workflows/testing.yml/badge.svg)](https://github.com/snap-stanford/relbench/actions/workflows/testing.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) [![Twitter](https://img.shields.io/twitter/url/https/twitter.com/cloudposse.svg?style=social&label=Follow%20%40RelBench)](https://twitter.com/RelBench) @@ -49,6 +50,14 @@ The training/validation/testing tables are automatically generated using pre-def task.evaluate(pred) ``` +# Demos +List of working demos: + +| Name | Description | +|-------|---------------------------------------------------------| +| [rel.stackex](examples/stackex/demo_stackex.ipynb) | exploring `rel-stackex` dataset and tasks | +| [102](tutorials/TDC_102_Data_Functions.ipynb) | Introduce TDC Data Functions | + # Cite RelBench If you use RelBench in your work, please cite our paper: