ml-agents icon indicating copy to clipboard operation
ml-agents copied to clipboard

Integrating Hugging Face Hub 🤗

Open simoninithomas opened this issue 2 years ago • 0 comments

Hey there 👋 ,

Proposed change(s)

  • Integrating Hugging Face Hub 🤗 in ML-Agents to allow users to download and upload models to the Hub.

I'm Thomas Simonini from Hugging Face 🤗 and we work on the integration of Hugging Face Hub with ML-Agents. The Hugging Face Hub works as a central place where anyone can share and explore saved models. The idea is to allow people to share and save their models on the hub.

The PR is a draft for now because none of the checklist are done.

An example of a model card and the tensorboard dashboard integrated in the Hub: https://huggingface.co/ThomasSimonini/Huggy_test

Here's an example:

  1. You train your agent mlagents-learn --config="huggy.yaml" --run-id="Huggy_1"
  2. After the training is done you push your model to the 🤗 Hub with mlagents-push-to-hf --run-id="Huggy_1" --local-dir="results/Huggy_1" --repo-id="ThomasSimonini/Huggy_test" --commit-message="Huggy upload"
  3. Someone else wants to download it, it just need to type mlagents-load-from-hf --repo-id="ThomasSimonini/Huggy_test" --local-dir="./downloads"

Types of change(s)

  • [ ] Bug fix
  • [X] New feature
  • [ ] Code refactor
  • [ ] Breaking change
  • [ ] Documentation update
  • [ ] Other (please describe)

Checklist

  • [ ] Added tests that prove my fix is effective or that my feature works
  • [ ] Updated the changelog (if applicable)
  • [ ] Updated the documentation (if applicable)
  • [ ] Updated the migration guide (if applicable)

Other comments

simoninithomas avatar Apr 20 '22 12:04 simoninithomas