A
add-example-doc-model-env
Automatycznie generuj dokumentację dla nowych modeli i środowisk w RLinf w angielskim i chińskim
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill do RLinf, który automatyzuje tworzenie stron dokumentacji (RST) dla nowych modeli lub środowisk testowych. Obsługuje trzy kategorie: embodied (roboty, manipulatory), agentic (agenci, reasoning) i system (scheduling, placement). Dokumentacja generowana jest jednocześnie w wersji angielskiej i chińskiej, a strony automatycznie rejestrują się w indeksach kategorii.
Jak używać
- Określ kategorię swojego modelu lub środowiska: embodied (np. ManiSkill, LIBERO, π₀), agentic (np. SearchR1, reasoning online) lub system (placement, scheduling). 2. Utwórz plik RST w odpowiednim katalogu: docs/source-en/rst_source/examples/[kategoria]/[nazwa].rst, gdzie [kategoria] to embodied, agentic lub system, a [nazwa] to slug Twojego modelu lub środowiska. Strukturę pliku przygotuj na wzór istniejących przykładów w tej samej kategorii. 3. Zarejestruj nową dokumentację w indeksie kategorii, edytując plik docs/source-en/rst_source/examples/[kategoria]/index.rst — dodaj wpis z nazwą pliku do sekcji toctree na dole pliku. 4. Opcjonalnie dodaj kartę galerii w indeksie kategorii, używając tego samego wzoru HTML co istniejące karty (obraz, link do dokumentu, tytuł i opis). 5. Jeśli dodajesz środowisko do embodied evaluation, postępuj zgodnie z dodatkowymi instrukcjami dla tego typu. 6. Dokumentacja zostanie automatycznie wygenerowana w wersji angielskiej i chińskiej.