NVIDIA-BioNeMo / NVIDIA-BioNeMo/Proteina-Complexa
[Proteina-Complexa] Setup docs overstate required credentials and mislabel DATA_PATH
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 432
- Forks
- 78
- Avg merge
- 10d 46m
- Merged PRs (30d)
- 1
Description
Two setup-config inaccuracies trip up new (UV) users:
GITLAB_TOKENsits in the top "Credentials" block as if required, but it's Docker-only (env/docker-ops.shregistry login; skipped when absent). A liveWANDB_ENTITYplaceholder also caused an "entity not found" 404 (username ≠ entity; blank = account default).LOCAL_DATA_PATH/DATA_PATHis labeled as holdingtarget_data/, but shipped targets use repo-relativetarget_path:;$DATA_PATHis only a fallback (binder_eval_utils.py:256). Design needs no realDATA_PATH.
Severity: Low · Status: fixed in .env_example; upstream docs open
Steps to reproduce
- Follow the setup docs / fill
.envas written, on the UV runtime. - → users think a GITLAB_TOKEN is required; the entity placeholder 404s W&B; users think a real
DATA_PATHis required just to run design.
Fix
Mark GITLAB_TOKEN Docker-only, comment out WANDB_ENTITY, and clarify DATA_PATH is a training/fallback path. (Done locally in .env_example.)
Environment
NVIDIA A100 80GB PCIe · driver 565.57.01 · CUDA 12.7 · repo branch dev @ 916eaae · UV runtime.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the shipped .env_example and the upstream setup docs, then check env/docker-ops.sh for GITLAB_TOKEN usage and binder_eval_utils.py:256 for DATA_PATH fallback behavior. Done means the docs mark GITLAB_TOKEN as Docker-only, leave WANDB_ENTITY commented out, and explain that DATA_PATH is only a training/fallback path rather than required for design.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100