facebookresearch/fmmax

Documentation

Aperta

#35 aperta il 30 ago 2023

Vedi su GitHubGuida contributor
 (0 commenti) (1 reazione) (0 assegnatari)Jupyter Notebook (15 fork)auto 404
documentationenhancementgood first issue

Metriche repository

Star
 (149 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Would be good to export the API docstrings into some documentation. The examples could be exported too (even better would be to export notebooks with the accompanying text explaining things).

Guida contributor

Direzione di ricerca
Utilizza un generatore di documentazione come Sphinx per creare automaticamente la documentazione API dai docstring e includi i notebook Jupyter come esempi. Assicurati che l'output sia user friendly e copra le funzionalità chiave.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80