Update documentation
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- Mezza giornata
- Idoneità per principianti
- 45/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Attiva
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
Start with the README Install section and USER_GUIDE.md, which need a Requirements note, PyPI and source install steps, and a protobuf troubleshooting entry. Check whether #233 and Goal 1 have landed, since they decide which HTA and PARAM steps to remove. Done means following the docs word for word in a clean venv, with chakra_trace_link running on a sample trace and the log attached. Several items depend on unmerged work, so confirm with a maintainer before editing.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Task
- README: an Install section with
pip install mlc-chakra. - USER_GUIDE.md:
- Requirements: agreed Python version.
- Install from PyPI.
- Install from source, for contributors:
pip install -e . -r requirements-dev.txt. - Troubleshooting: a protobuf
VersionErrormeans something downgraded protobuf, so runpip install "protobuf>=6.31.1,<8"(#195).
- Remove the HTA clone steps, if #233 hasn't already.
- No separate
et_replaystep (if possible): Goal 1 attempts to make it install with Chakra. Remove the PARAM install step if Goal 1 did what was proposed. - C++ feeder: replace the "Execution Trace Feeder" section with a short note explaining what happened with it.
Acceptance criteria
- Following README and USER_GUIDE word for word in a clean venv on the Python versions works, and
chakra_trace_linkruns on a sample trace. Evidence: log or CI run.
Depends on
The first release (Goal 5) and et_replay installing (Goal 1).
Under continuous deployment, merging this publishes the next patch, so the PyPI page gets the new README.
- Lingua principale
- Python
- Stelle
- 201
- Fork
- 87
- Merge medio
- 6g 43m
- PR unite (30g)
- 2
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di mlcommons/chakra
-
Release notes from PR titlesAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
-
Add code formatting checkAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
-
Remove gRPC code generationAperta
Difficoltà 3/5 Mezza giornata Idoneità per principianti 35/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 22/100
Tutte le issue di mlcommons/chakra
Issue simili
-
bump patch
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
autowarefoundation/autoware_carla_scenario#1321 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 78/100
QuantConnect/Documentation#2838 ·
I maintainer di solito rispondono entro 1 giorno
-
get_all_subclasses must deduplicate by class identityForse già presa @Gambit-Checkmate l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
I maintainer di solito rispondono entro 15 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
awslabs/route53-dynamic-dns-with-lambda#67 · 1 commento ·