Hub documentation

استخدام Stable-Baselines3 على Hugging Face

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

استخدام Stable-Baselines3 على Hugging Face

stable-baselines3 هو مجموعة من التطبيقات الموثوقة لخوارزميات التعلم المعزز في PyTorch.

استكشاف Stable-Baselines3 في Hub

يمكنك العثور على نماذج Stable-Baselines3 عن طريق التصفية على يسار صفحة النماذج.

تأتي جميع النماذج على Hub بميزات مفيدة:

  1. بطاقة نموذج مُولَّدة تلقائيًا تتضمن وصفًا وإعدادات تدريب وغيرها.
  2. وسوم البيانات الوصفية التي تساعد في إمكانية الاكتشاف.
  3. نتائج التقييم للمقارنة مع نماذج أخرى.
  4. مكوّن فيديو يمكنك من خلاله مشاهدة أداء وكيلك.

تثبيت المكتبة

لتثبيت مكتبة stable-baselines3، تحتاج إلى تثبيت حزمتين:

  • stable-baselines3: مكتبة Stable-Baselines3.
  • huggingface-sb3: كود إضافي لتحميل نماذج Stable-baselines3 من Hub ورفعها.
pip install stable-baselines3
pip install huggingface-sb3

استخدام نماذج موجودة

يمكنك ببساطة تنزيل نموذج من Hub باستخدام الدالة load_from_hub

checkpoint = load_from_hub(
    repo_id="sb3/demo-hf-CartPole-v1",
    filename="ppo-CartPole-v1.zip",
)

يجب عليك تحديد معلمتين:

  • --repo-id: اسم مستودع Hugging Face الذي تريد تنزيله.
  • --filename: الملف الذي تريد تنزيله.

مشاركة نماذجك

يمكنك بسهولة رفع نماذجك باستخدام دالتين مختلفتين:

  1. package_to_hub(): حفظ النموذج، وتقييمه، وإنشاء بطاقة نموذج، وتسجيل فيديو إعادة تشغيل لوكيلك قبل دفع المستودع الكامل إلى Hub.
package_to_hub(model=model, 
               model_name="ppo-LunarLander-v2",
               model_architecture="PPO",
               env_id=env_id,
               eval_env=eval_env,
               repo_id="ThomasSimonini/ppo-LunarLander-v2",
               commit_message="Test commit")

تحتاج إلى تحديد سبع معاملات:

  • --model: النموذج المدرّب الخاص بك.
  • --model_architecture: اسم بنية نموذجك (DQN، PPO، A2C، SAC…).
  • --env_id: اسم البيئة.
  • --eval_env: البيئة المستخدمة لتقييم الوكيل.
  • --repo-id: اسم مستودع Hugging Face الذي تريد إنشاؤه أو تحديثه. وهو <your huggingface username>/<the repo name>.
  • --commit-message.
  • --filename: الملف الذي تريد رفعه إلى Hub.
  1. push_to_hub(): ببساطة، ادفع ملفًا إلى Hub
push_to_hub(
    repo_id="ThomasSimonini/ppo-LunarLander-v2",
    filename="ppo-LunarLander-v2.zip",
    commit_message="Added LunarLander-v2 model trained with PPO",
)

يجب عليك تحديد ثلاثة معلمات:

  • --repo-id: اسم مستودع Hugging Face الذي تريد إنشاؤه أو تحديثه. وهو <your huggingface username>/<the repo name>.
  • --filename: الملف الذي تريد رفعه إلى Hub.
  • --commit-message.

موارد إضافية

Update on GitHub