andrew-bitmind commited on
Commit
40ce811
·
verified ·
1 Parent(s): 09ac919

Initial submission instructions

Browse files
Files changed (1) hide show
  1. app.py +32 -0
app.py CHANGED
@@ -194,6 +194,38 @@ with gr.Blocks(theme=gr.themes.Base()) as demo:
194
  # # Submit Detector Results Form
195
  with gr.TabItem("🚀 Submit Detector Results"):
196
  gr.Markdown("Submit your detector results for evaluation.")
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
197
 
198
  with gr.Row():
199
  detector_name = gr.Textbox(label="Detector Name", placeholder="e.g., MyDetector")
 
194
  # # Submit Detector Results Form
195
  with gr.TabItem("🚀 Submit Detector Results"):
196
  gr.Markdown("Submit your detector results for evaluation.")
197
+
198
+ # Add submission instructions
199
+ gr.Markdown("""
200
+ ### Submission Instructions
201
+
202
+ 1. Ensure that your detector code follows the [dfd arena repository](https://github.com/BitMind-AI/dfd-arena/tree/main) detectors format. The best way to guarantee compatibility is to develop and test your detector within a local copy of our repo, with dependencies, detector file, and configs in relative locations similar to how we structured our implementations of UCF, NPR, and CAMO detectors.
203
+
204
+ **✅ Check list:**
205
+ - Your code should work with detector dependencies (architecture and training code) imported from a dependencies directory a level above the detector directory.
206
+ - e.g., `arena/detectors/deepfake_detectors/ucf_detector.py` relies on a dependency folder at `arena/detectors/UCF/`
207
+ - Our automated benchmarking pipeline will reconstruct the required directory at evaluation time
208
+ - Implement a `.py` file in `arena/detectors/deepfake_detectors/` containing a `DeepfakeDetector` subclass with PascalCase naming convention, registered as a module in the dfd-arena `DETECTOR_REGISTRY`.
209
+ - e.g., in `myCustomDetector.py`,
210
+ ```python
211
+ @DETECTOR_REGISTRY.register_module(module_name='MyCustomModuleName')
212
+ class MyCustomDetector(DeepfakeDetector):
213
+ # implementation
214
+ ```
215
+ - The module name should match the detector name you want to appear on the leaderboard
216
+ - Create a config YAML file that the DeepfakeDetector loads in `arena/detectors/deepfake_detectors/configs/`.
217
+
218
+ 2. Create a HuggingFace model repo with the detector `.py` file, config `.yaml`, and dependencies in the same root level. [Check out our Sample Leaderboard Submission Repo for Reference!](https://huggingface.co/caliangandrew/submit_test/tree/main)
219
+
220
+ 3. 📤 Fill out the form below with the correct paths and submit! The results will be processed after a code review by the BitMind team, and an automated test/benchmarking stage.
221
+
222
+ **⚠️ Note:** The Detector Name must match the name of the registered detector module in the dfd arena detector registry. This will be the name of your detector on our leaderboard.
223
+ - For example, using the [Sample Submission Repo](https://huggingface.co/caliangandrew/submit_test/tree/main) provided, you would submit:
224
+ - Detector Name: `test`
225
+ - Hugging Face Model Repo: `caliangandrew/submit_test`
226
+ - Path to detector `.py`: `test_detector.py`
227
+ - Path to config `.YAML`: `test_config.yaml`
228
+ """)
229
 
230
  with gr.Row():
231
  detector_name = gr.Textbox(label="Detector Name", placeholder="e.g., MyDetector")