boavizta/open_data_boamps

Guide: How to share your data on the BoAmps repository

This guide explains step by step how to share BoAmps format reports on this public Hugging Face repository.

Prerequisites

Before starting, make sure you have:

• A Hugging Face account
• The files you want to upload

Method 1: Hugging Face Web Interface

1. Log in to Hugging Face

2. Go to the boamps dataset

3. Navigate to the files: Click on "Files and versions" then on the "data" folder

4. Click on "Contribute" then "Upload files"

5. Drop your files in BoAmps format (please name them clearly) and give a name to the PR (e.g. 10 reports on image classification). You can add an extended description but this is optional. The name of the files should follow this format : "report_<publisher>_<taskStage>_<taskFamily>_<infraType>_<reportID>.json"

• <publisher>: the name of the publisher (this can be useful for gathering reports written by the same person, but you can of course create a pseudonym if you wish to remain anonymous)
• <taskStage>: mandatory field of the report
• <taskFamily>: mandatory field of the report
• <infraType>: mandatory field of the report
• <reportID>: optionnal

1. At the bottom of the page, click on "Open a Pull Request".
2. You should see your PR created in "Community" > "Pull request". Now just wait for our team to validate your PR, thank you very much for your participation and your commitment to more frugal AI, in full transparency!

Method 2: Git (Command Line)

1. Clone the repository
2. Create a branch
3. Add your files
4. Create a PR