Personal endpoint docs path + graceful remote timeout handling#58
Merged
Merged
Conversation
…andling
Docs:
- README router now distinguishes "your own personal endpoint" (case 3) from
"shared/group endpoint operator" (case 4). The first was previously folded
into the sysadmin path and underserved.
- docs/operating-an-endpoint.md opens with a 30-minute solo personal quickstart
(six commands plus one config edit) before the full 8-step shared setup,
with clear pointers to when each piece of hardening becomes mandatory.
- AGENTS.md adds an "upfront remote expectation setting" rule so the agent
surfaces target endpoint, queue characteristics, and timeout to the user
before invoking any use_remote=True tool.
Code:
- remote/health.py: replace `with Executor(...) as ex:` with explicit
try/finally + ex.shutdown(wait=False). The context manager drained
pending futures on exit, which caused probes against a slow or wedged
endpoint to hang for the full timeout (and sometimes much longer) instead
of returning.
- tools/remote_tools.py: wrap the remote call in try/except so a TimeoutError
becomes an actionable message ("job likely waiting in Slurm/PBS queue,
raise timeout_seconds or wait") instead of a bare traceback.
Lock:
- uv.lock catches up to the 0.1.1 package version already in pyproject.toml.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Why
Two pain points hit in real use:
Test plan