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 a comment about CPTC dataset in README.md #53

Merged
merged 1 commit into from
Oct 9, 2023
Merged

Add a comment about CPTC dataset in README.md #53

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Repository to accompany our publications

## Hassle-free way to run SAGE

Switch to the [`docker` branch](https://github.com/tudelft-cda-lab/SAGE/tree/docker) to download and run SAGE inside a docker container. No additional installations are required in that case.
Switch to the [`docker` branch](https://github.com/tudelft-cda-lab/SAGE/tree/docker) to download and run SAGE inside a docker container. No additional installations are required in that case.

## Run SAGE yourself

Expand Down Expand Up @@ -65,7 +65,12 @@ Tip: in case you often use the same non-default values, you can create an alias

`python sage.py alerts/ firstExp`,

where `alerts/` contains the uncompressed alerts. For other options, see Usage section above.
where `alerts/` contains the uncompressed alerts.
- NB! If you use the CPTC dataset, don't forget to add `--dataset cptc`, e.g.:

`python sage.py alerts/ firstExp --dataset cptc`

- For other options, see Usage section above.

**If you use SAGE in a scientific work, consider citing the following papers:**

Expand Down