Hello everyone,
The official submission document mentioned “hf_models: A list of Hugging Face models your agent depends on. These models must be publicly available or the aicrowd HF account must have access. Important: If your model is private, grant the aicrowd user permission to pull it, or your submission will fail.”
But how do we specifically authorize the private model on huggingface to aicrowd?
Looking forward to your responses and good luck to everyone competing!
Best regards
Do I need to create an organization on huggingface and then invite the aicrowd official account to join my organization to share my private model? Is there a more convenient way?
ChatGPT says we can add them as collaborators under settings. What is aicrowd’s HF username?
Hi @Chris_Deotte ,
The docs for referencing private HF repos is added to the (soon to be released) starter kit here.
We will make an announcement soon once the evaluators are ready to support the new starter kit.
Update: We have slightly changed the interfacing with Huggingface, and how we expect teams to securely submit their models via Hugginface. The key change is that, we want people to have their models available as “Public Gated” repos on Huggingface instead of Private repos. We have added step by step instructions for the same here: Using Gated Hugging Face Models in Your Submission 
@mohanty
I would like to know how to submit a private model.
Using Gated Hugging Face Models in Your Submission states that aicrowd.json must include “aicrowd” in the “repository name” of huggingface, and provides the following example.
On the other hand, since the part of <owner>/<model name> of a hugging face account that has already been created is the username, it is difficult to change it (when I actually tried to change it, I got a warning that the username can only be changed once).
"hf_models": [
{
"repo_id": "your-team-aicrowd/your-model",
"revision": "main"
}
]
Also, Getting Started with Repositories states that the model name in <owner>/<model name> is the repository name, as follows:
3.Enter your model’s name. This will also be the name of the repository.
For this reason, I thought the following might be correct, so I prepared a gated hugging face model like the one below and submitted it, but an error occurred.
"hf_models": [
{
"repo_id": "your-team/aicrowd-your-model",
"revision": "main"
}
]
In that case, do I need to include aicrowd in the part of <owner>/<model name> in Using Gated Hugging Face Models in Your Submission?
In other words, do I really need to change the username of the huggingface account I’ve already created?
@yilun_jin8
As the deadline for Phase 1 is approaching, we will add a mention.
Thank you in advance.
Hello @msuzuki
You don’t need to change your HF username. Ensure that your repo has aicrowd in the name and @aicrowd has access to the repo. That should do.
@jyotish
Thanks for the reply!
So, am I correct in understanding that the correct repository name for huggingface is “your-team/aicrowd-your-model” and aicrowd.json should be as follows?
(This is different from how aicrowd.json is described in Using Gated Hugging Face Models in Your Submission)
"hf_models": [
{
"repo_id": "your-team/aicrowd-your-model",
"revision": "main"
}
]
@msuzuki The example you shared should work. We need the repo name to have aicrowd. Updated the example in the docs to avoid this confusion.
@jyotish
Thank you for your quick response.
Even if I grant aicrowd access rights to the huggface repository using the method above and submit, I still get an error that seems to be a permission issue, so I’ll investigate the cause of the error.