Update README.md

README.md

@@ -31,6 +31,17 @@ Each "story" is a sample of the dataset and can vary in length and complexity.
 The dataset contains 8,881 samples, divided into train and validation splits.
 ![StoryFrames dataset distribution](storyframes-scene-dist-tabblue-taborange.png)
 
+If you want to work with a specific context length (i.e., number of scenes per story), you can filter the dataset as follows:
+
+```python
+from datasets import load_dataset
+
+ds = load_dataset("ingoziegler/StoryFrames")
+
+# to work with stories containing 3 scenes
+ds_3 = ds.filter(lambda sample: sample["num_scenes"] == 3)
+```
+
 ## What Is a Story in StoryFrames?
 * **A story is a sequence of scenes:**
 Each story is composed of multiple scenes, where each scene is a part of the overall narrative.
@@ -52,3 +63,62 @@ Each story is composed of multiple scenes, where each scene is a part of the ove
 * **Narrative Descriptions:**
   * `sentence_parts`: This field contains a list of strings. Each string provides a description for one scene in the story. Even though a scene is made up of multiple images, the corresponding description captures the plot progression over all images of that scene.
  
+## Detailed Field Descriptions
+* `sentence_parts`
+  * Type: `List[str]`
+  * A narrative breakdown where each entry describes one scene.
+
+* `start_times`
+  * `List[float]`
+  * A list of timestamps marking the beginning of each scene.
+
+* `end_times`
+  * Type: `List[float]`
+  * A list of timestamps marking the end of each scene.
+
+* `background_description`
+  * Type: `str`
+  * A brief summary of the overall setting or background of the story.
+
+* `video_name`
+  * Type: `str`
+  * The identifier or name of the source video.
+  * This is not a unique identifier for stories as a video can contain multiple stories that are annotated separately.
+
+* `question_info`
+  * Type: `str`
+  * Additional information used together with the video name to uniquely identify each story.
+
+* `story_id`
+  * Type: `str`
+  * Automatically generated by combining `video_name` and `question_info` (e.g., "video_name---question_info") to create a unique identifier for each story.
+
+* `num_actors_in_video`
+  *  Type: `int`
+  * The number of actors present in the video.
+
+* `subsampled_frames_per_scene`
+  * Type: `List[List[float]]`
+  * Each inner list contains the timestamps (formatted as `frame_sec.millisec`, e.g., `frame_1.448629`) for the frames that were selected from a scene.
+  * Each position of the inner lists correspond to the position of the description in `sentence_parts` and `scenes`,
+  * The number of inner lists corresponds to the number of available `scenes`, as marked in `num_scenes`.
+
+* `scenes`
+  * Type: `List[List[Image]]`
+  * Each inner list holds the actual frames (images) that were subsampled from a scene.
+  * The structure of this field directly corresponds to that of `subsampled_frames_per_scene`.
+  * Each position of the inner lists correspond to the position of the description in `sentence_parts` and `subsampled_frames_per_scene`.
+
+* `num_scenes`
+  * Type: `int`
+  * The total number of scenes in the story.
+
+* `caption`
+  * Type: `str`
+  * An optional caption for the sample.
+  * This may be empty if no caption was provided.
+
+* `sentence_parts_nocontext`
+  * Type: `List[str]`
+  * A variant of the scene descriptions that excludes sequential context.
+  * This may be empty if no annotation was provided.