update README.md
Browse files
README.md
CHANGED
|
@@ -1,51 +1,51 @@
|
|
| 1 |
-
---
|
| 2 |
-
license: apache-2.0
|
| 3 |
-
---
|
| 4 |
-
|
| 5 |
-
# Guide: How to share your data on the BoAmps repository
|
| 6 |
-
|
| 7 |
-
This guide explains step by step how to share BoAmps format reports on this public Hugging Face repository.
|
| 8 |
-
|
| 9 |
-
## Table of Contents
|
| 10 |
-
- [Guide: How to share your data on the BoAmps repository](#guide-how-to-share-your-data-on-the-boamps-repository)
|
| 11 |
-
- [Table of Contents](#table-of-contents)
|
| 12 |
-
- [Prerequisites](#prerequisites)
|
| 13 |
-
- [Method 1: Hugging Face Web Interface](#method-1-hugging-face-web-interface)
|
| 14 |
-
- [Method 2: Git (Command Line)](#method-2-git-command-line)
|
| 15 |
-
|
| 16 |
-
## Prerequisites
|
| 17 |
-
|
| 18 |
-
Before starting, make sure you have:
|
| 19 |
-
- A Hugging Face account
|
| 20 |
-
- The files you want to upload
|
| 21 |
-
|
| 22 |
-
## Method 1: Hugging Face Web Interface
|
| 23 |
-
|
| 24 |
-
1. Log in to Hugging Face
|
| 25 |
-
2. Go to [the boamps dataset](https://huggingface.co/datasets/boavizta/open_data_boamps)
|
| 26 |
-
3. Navigate to the files: Click on "Files and versions" then on the "data" folder
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
4. Click on "Contribute" then "Upload files"
|
| 30 |
-
|
| 31 |
-
|
| 32 |
-
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.
|
| 33 |
-
The name of the files should follow this format :
|
| 34 |
-
"report_\<publisher>_\<taskStage>_\<
|
| 35 |
-
- \<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)
|
| 36 |
-
- \<taskStage>: mandatory field of the report
|
| 37 |
-
- \<
|
| 38 |
-
- \<infraType>: mandatory field of the report
|
| 39 |
-
- \<reportID>: optionnal
|
| 40 |
-
|
| 41 |
-
1. At the bottom of the page, click on "Open a Pull Request".
|
| 42 |
-
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!
|
| 43 |
-
|
| 44 |
-
|
| 45 |
-
|
| 46 |
-
## Method 2: Git (Command Line)
|
| 47 |
-
|
| 48 |
-
1. Clone the repository
|
| 49 |
-
2. Create a branch
|
| 50 |
-
3. Add your files
|
| 51 |
-
4. Create a PR
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: apache-2.0
|
| 3 |
+
---
|
| 4 |
+
|
| 5 |
+
# Guide: How to share your data on the BoAmps repository
|
| 6 |
+
|
| 7 |
+
This guide explains step by step how to share BoAmps format reports on this public Hugging Face repository.
|
| 8 |
+
|
| 9 |
+
## Table of Contents
|
| 10 |
+
- [Guide: How to share your data on the BoAmps repository](#guide-how-to-share-your-data-on-the-boamps-repository)
|
| 11 |
+
- [Table of Contents](#table-of-contents)
|
| 12 |
+
- [Prerequisites](#prerequisites)
|
| 13 |
+
- [Method 1: Hugging Face Web Interface](#method-1-hugging-face-web-interface)
|
| 14 |
+
- [Method 2: Git (Command Line)](#method-2-git-command-line)
|
| 15 |
+
|
| 16 |
+
## Prerequisites
|
| 17 |
+
|
| 18 |
+
Before starting, make sure you have:
|
| 19 |
+
- A Hugging Face account
|
| 20 |
+
- The files you want to upload
|
| 21 |
+
|
| 22 |
+
## Method 1: Hugging Face Web Interface
|
| 23 |
+
|
| 24 |
+
1. Log in to Hugging Face
|
| 25 |
+
2. Go to [the boamps dataset](https://huggingface.co/datasets/boavizta/open_data_boamps)
|
| 26 |
+
3. Navigate to the files: Click on "Files and versions" then on the "data" folder
|
| 27 |
+
|
| 28 |
+
|
| 29 |
+
4. Click on "Contribute" then "Upload files"
|
| 30 |
+
|
| 31 |
+
|
| 32 |
+
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.
|
| 33 |
+
The name of the files should follow this format :
|
| 34 |
+
"report_\<publisher>_\<taskStage>_\<taskFamily>_\<infraType>_\<reportID>.json"
|
| 35 |
+
- \<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)
|
| 36 |
+
- \<taskStage>: mandatory field of the report
|
| 37 |
+
- \<taskFamily>: mandatory field of the report
|
| 38 |
+
- \<infraType>: mandatory field of the report
|
| 39 |
+
- \<reportID>: optionnal
|
| 40 |
+
|
| 41 |
+
1. At the bottom of the page, click on "Open a Pull Request".
|
| 42 |
+
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!
|
| 43 |
+
|
| 44 |
+
|
| 45 |
+
|
| 46 |
+
## Method 2: Git (Command Line)
|
| 47 |
+
|
| 48 |
+
1. Clone the repository
|
| 49 |
+
2. Create a branch
|
| 50 |
+
3. Add your files
|
| 51 |
+
4. Create a PR
|