-
Notifications
You must be signed in to change notification settings - Fork 13
Update CLI docs #1299
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update CLI docs #1299
Conversation
☂️ Python Coverage
Overall Coverage
New FilesNo new covered files... Modified Files
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mostly looks good to me. Please see my comments for details.
|
||
- `--distribution-strategy` | ||
Strategy to distribute the task across CPUs or nodes. | ||
Options: `multiprocessing`, `slurm`, `kubernetes`, `sequential`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unterstützen wir kubernetes wirklich noch?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ja, aber können wir mal rausschmeißen.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Soll ich es dann jetzt schon aus der Doku entfernen, oder wäre das ein follow up?
docs/src/cli/merge-fallback.md
Outdated
## Notes | ||
|
||
- Ensure that the target dataset, source annotation, and dataset directory are correctly accessible. | ||
- Set any necessary environment variables or credentials for remote paths. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Verlinke zur Authentication Docs seite
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ich denke es sollte eine extra seite für env vars geben, weil die für verschiedene commands gehen.
- WK_TOKEN
- WK_URL
- AWS_ACCESS_KEY_ID
- AWS_SECRET_ACCESS_KEY
- S3_ENDPOINT_URL
- HTTP_BASIC_USER
- HTTP_BASIC_PASSWORD
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hab eine Seite dafür aufgemacht, @hotzenklotz welche Authentication docs Seite meinst du?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Die Seite würde ich denke ich eher nicht für die CLI docs Seiten verwenden, da wk.webknossos_context()
ja vor allem für die Nutzer gedacht ist, die die libs nutzen. Wenn man nur mit der CLI arbeitet stiftet das denke ich eher Verwirrung. Aber ich kann an der Stelle ja nochmal auf die Seite mit den möglichen environment Variablen verweisen.
Description:
Issues:
Todos:
Make sure to delete unnecessary points or to check all before merging: