Skip to content

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

Merged
merged 8 commits into from
May 19, 2025
Merged

Update CLI docs #1299

merged 8 commits into from
May 19, 2025

Conversation

markbader
Copy link
Contributor

@markbader markbader commented May 8, 2025

Description:

  • This PR updates the CLI docs to offer a separate page for each command, an installation instruction page and a page for contributions.

Issues:

Todos:

Make sure to delete unnecessary points or to check all before merging:

  • Updated Documentation

@markbader markbader self-assigned this May 8, 2025
Copy link

github-actions bot commented May 8, 2025

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines Covered Coverage Threshold Status
8638 7215 84% 80% 🟢

New Files

No new covered files...

Modified Files

File Coverage Status
webknossos/webknossos/cli/download.py 83% 🟢
TOTAL 83% 🟢

updated for commit: 0b2ca0a by action🐍

Copy link
Member

@hotzenklotz hotzenklotz left a 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`.
Copy link
Member

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?

Copy link
Member

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.

Copy link
Contributor Author

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?

## Notes

- Ensure that the target dataset, source annotation, and dataset directory are correctly accessible.
- Set any necessary environment variables or credentials for remote paths.
Copy link
Member

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

Copy link
Member

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

Copy link
Contributor Author

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?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

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.

@markbader markbader merged commit 468ef58 into master May 19, 2025
20 checks passed
@markbader markbader deleted the cli-docs branch May 19, 2025 09:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Download CLI parse WK_URL from --url argument Improve CLI docs
3 participants