Documentation

You can use the hq doc command to show a URL to a page about a specific topic from this documentation. If you use the --open flag, HyperQueue will directly open a browser tab pointing to that page.

The following documentation pages are currently supported:

• hq doc job: Information about tasks and jobs.
• hq doc taskarray: Information about task arrays.
• hq doc resources: Information about resources.
• hq doc worker: Information about workers.
• hq doc autoalloc: Information about automatic allocation.
• hq doc python-api: Information about the Python API.
• hq doc cheatsheet: Link to the HQ cheatsheet.
• hq doc changelog: Link to the HQ changelog.
• hq doc faq: Link to frequently asked questions.