Enhance InFlux dataset card: Add metadata, links, and sample usage

README.md

@@ -1,13 +1,21 @@
 ---
 license: cc-by-4.0
+task_categories:
+- depth-estimation
+tags:
+- camera-calibration
+- intrinsics
+- video
 ---
 
 # InFlux
 
-We present Intrinsics in Flux (InFlux), a real-world benchmark that provides per-frame ground truth intrinsics annotations for videos with dynamic intrinsics. Compared to prior benchmarks, InFlux captures a wider range of intrinsic variations and scene diversity, featuring 143K+ annotated frames from 386 high-resolution indoor and outdoor videos with dynamic camera intrinsics.  
+We present Intrinsics in Flux (InFlux), a real-world benchmark that provides per-frame ground truth intrinsics annotations for videos with dynamic intrinsics. Compared to prior benchmarks, InFlux captures a wider range of intrinsic variations and scene diversity, featuring 143K+ annotated frames from 386 high-resolution indoor and outdoor videos with dynamic camera intrinsics.
 
-For more information about this dataset, please visit our website: https://influx.cs.princeton.edu/. Please find data download and submission instructions in the [official repository](https://github.com/princeton-vl/InFlux/tree/main).
+This dataset is presented in the paper [InFlux: A Benchmark for Self-Calibration of Dynamic Intrinsics of Video Cameras](https://huggingface.co/papers/2510.23589).
 
+Project page: https://influx.cs.princeton.edu/
+Code: https://github.com/princeton-vl/InFlux
 
 ### Viewing `.mp4` Files
 
@@ -17,14 +25,14 @@ The `.mp4` files in this dataset require VLC media viewer to play locally. Pleas
 
 The dataset includes 386 `.mp4` videos and 2 `.json` files in the root directory:
 
-- **Dynamic Intrinsics Videos (`.mp4`)**  
-  Videos with dynamic intrinsics, moving objects, and camera motion.  
+-   **Dynamic Intrinsics Videos (`.mp4`)**  
+    Videos with dynamic intrinsics, moving objects, and camera motion.  
 
-- **Frame Counts and Split (`video_frame_count_and_split.json`)**  
-  Maps each video to its number of frames and whether it belongs to the validation or test split.  
+-   **Frame Counts and Split (`video_frame_count_and_split.json`)**  
+    Maps each video to its number of frames and whether it belongs to the validation or test split.  
 
-- **Validation Ground Truth (`gt_validation_dict.json`)**  
-  Maps validation video frames to ground truth intrinsics values.
+-   **Validation Ground Truth (`gt_validation_dict.json`)**  
+    Maps validation video frames to ground truth intrinsics values.
 
 ---
 
@@ -41,9 +49,9 @@ The dataset includes 386 `.mp4` videos and 2 `.json` files in the root directory
 }
 ```
 
-- `frame_count` – Number of frames in the video.
+-   `frame_count` – Number of frames in the video.
 
-- `split` – Denotes which split the video belongs in. The value will either be "val" or "test".
+-   `split` – Denotes which split the video belongs in. The value will either be "val" or "test".
 
 #### `gt_validation_dict.json`
 
@@ -68,9 +76,110 @@ The dataset includes 386 `.mp4` videos and 2 `.json` files in the root directory
 ```
 
 **Per-frame keys:**
-- `intrinsics_gt` – Ground truth intrinsics from look-up table (LUT) interpolation.
-    - `fx, fy, cx, cy, k1, k2, p1, p2` denote the intrinsics parameters as specified by the rad-tan Brown-Conrady distortion model.
+-   `intrinsics_gt` – Ground truth intrinsics from look-up table (LUT) interpolation.
+    -   `fx, fy, cx, cy, k1, k2, p1, p2` denote the intrinsics parameters as specified by the rad-tan Brown-Conrady distortion model.
 
-- `intrinsics_gt_extrapolated` – The same as `intrinsics_gt`, but also provides extrapolated intrinsics if lens metadata is outside of LUT bounds. It contains the same fields as `intrinsics_gt`.
+-   `intrinsics_gt_extrapolated` – The same as `intrinsics_gt`, but also provides extrapolated intrinsics if lens metadata is outside of LUT bounds. It contains the same fields as `intrinsics_gt`.
 
-- `lens_metadata` – Raw physical lens parameters `focal_length_mm`, `focus_distance_m`
+-   `lens_metadata` – Raw physical lens parameters `focal_length_mm`, `focus_distance_m`
+
+### Sample Usage
+
+To evaluate your camera intrinsics prediction method using the InFlux benchmark:
+
+#### Installation
+
+For basic functionality (submitting results):
+```bash
+conda create --name influx python=3.10
+conda activate influx
+pip install .
+```
+
+#### Submission Format
+
+First, generate a single submission json with the following format:
+
+**`submission.json`**:
+
+```json
+{
+    "submission_metadata": {
+        "method_name": "your_method_name",
+        "intrinsics_type": "rad-tan"   // or "mei"
+    },
+    "test_video1": {
+        "0": {                         // Frame index as a string
+            "fx": 0.0,
+            "fy": 0.0,
+            "cx": 0.0,
+            "cy": 0.0,
+            "k1": 0.0,
+            "k2": 0.0,
+            "p1": 0.0,
+            "p2": 0.0
+        },
+        "1": {
+            "fx": 0.0,
+            "fy": 0.0,
+            "cx": 0.0,
+            "cy": 0.0,
+            "k1": 0.0,
+            "k2": 0.0,
+            "p1": 0.0,
+            "p2": 0.0
+        }
+        // ... continue for all frames in the test video
+    },
+    "test_video2": {
+        // same format for other test videos
+    }
+}
+```
+**Notes**:
+- All frame indices must be strings (e.g., "0", "1", "2", …). Do not use leading zeros.
+- `intrinsics_type` must be either "rad-tan" or "mei".
+- If your method uses a different intrinsics type, please contact us at influxbenchmark@gmail.com
+
+To generate an example submission json that is formatted correctly but needs values filled in, you can run the following command:
+```bash
+influx-generate-sample \
+    --intr-type <rad-tan|mei> \
+    --output <path/to/output_file.json>
+```
+
+#### Submit Your Results
+
+Submit your predictions to the evaluation server using the command below. Replace the placeholders:
+
+```bash
+influx-upload \
+    --email your_email \
+    --path path_to_your_submission_json \
+    --method_name your_method_name
+```
+
+**Important**: the `--method_name` argument must exactly match the `method_name` specified in the `submission_metadata` section of your JSON file.
+
+After submission, a validation function will check your JSON file. To ensure it passes:
+- Avoid special characters or spaces in the **file name** and **method name**.
+- Include **all test videos and frames** in your submission.
+- Provide **all required intrinsics** for the specified `intrinsics_type` for every frame.
+- Ensure that `fx`, `fy`, `cx`, and `cy` values are non-negative.
+
+#### Making Your Submission Public
+
+To make your submission public, run:
+
+```bash
+influx-make-public \
+    --id submission_id \
+    --email your_email \
+    --anonymous False \
+    --method_name your_method_name \
+    --publication "your publication name" \
+    --url_publication "https://your_publication" \
+    --url_code "https://your_code" \
+```
+
+You may set `"Anonymous"` as the publication name if the work is under review. The `url_publication`, `url_code` fields are optional.