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

update readme with demos and testing badge #56

Merged
merged 2 commits into from
Nov 27, 2023
+9 −0
Merged

update readme with demos and testing badge #56

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce696cc
update readme with demos and testing badge
kexinhuang12345 Nov 27, 2023
4da549b
Merge branch 'main' into update-readme
rishabh-ranjan Nov 27, 2023
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
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -51,6 +52,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:
Expand Down
Loading