Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Jelena Mirkovic committed Jan 23, 2024
1 parent f5c5d8e commit 54513f2
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,31 @@ All datasets are sub-grouped into letter directories based on the
initial letter of the dataset name. Within each letter directory is a
directory for datasets that contain labels. Within each dataset
directory is a subdirectory from the creator of the labels, with
"provider" being a reserved subdirectory name for labels that came
from the dataset provider.
"provider-somenamehere" being a reserved subdirectory name for labels that came
from the dataset provider.

As an example, labels created by the provider for the
/B_Root_Anomaly-20190907/ dataset can be found in:

B/B_Root_Anomaly-20190907/provider

B/B_Root_Anomaly-20190907/provider-uscisiant

When citing labels, please use the label name (omit "provider" if present)
and dataset name. For example provider-uscisiant labels from the above
example could be cited as "uscisiant labels for B_Root_Anomaly-20190907
dataset".

In each subdirectory containing labels, please refer to the specific
README file that describes the associated labels or tools to create
the labels and how to use them.

Each leaf folder relates to a specific dataset
and contains labeling program if any, and information needed to
Each leaf folder relates to a specific dataset. Labels come in many
flavors - per-record or per-event labels. In some cases there will be
a labeling program or pointers to it, and information needed to
run this program with the original dataset to obtain per-record labels.

## Supporting tools

In some cases, tools have created to "generate" labels using the
In some cases, tools have been created to "generate" labels using the
dataset as an input. These tools, and descriptions about how to
compile and use them, will either be in the dataset subdirectory
itself or may exist in the /tools/ subdirectory, under the label
Expand Down

0 comments on commit 54513f2

Please sign in to comment.