Usable "getting started" docs in README, both interpreter and Jupyter
#953
Conversation
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
jamesbraza
requested review from
whitead,
sremo,
mskarlin,
maykcaldas and
ludomitch
dosubot
bot
added
size:L
jamesbraza
commented
May 21, 2025
| @@ -190,13 +192,13 @@ search over that index, then break the files into chunked evidence contexts, ran | |||
| All prior answers will be indexed and stored, you can view them by querying via the `search` subcommand, or access them yourself in your `PQA_HOME` directory, which defaults to `~/.pqa/`. | |||
|
|
|||
| ```bash | |||
| $ pqa search -i 'answers' 'antibodies' | |||
There was a problem hiding this comment.
This didn't run earlier regardless
There was a problem hiding this comment.
Pull Request Overview
This PR improves usability by adding a run_or_ensure function to support both synchronous interpreter and asynchronous Jupyter notebook environments. It also updates the CLI usage in the README and adjusts agent functions to leverage the new utility.
- Introduces run_or_ensure for coroutine handling.
- Modifies several agent functions in init.py to use run_or_ensure instead of directly calling get_loop().
- Updates README snippets to reflect the changes and enhance usability.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| paperqa/utils.py | Adds the run_or_ensure function and updates imports. |
| paperqa/agents/init.py | Updates function implementations to use run_or_ensure for async handling. |
| README.md | Revises CLI examples to match the updated functionality. |
Comments suppressed due to low confidence (1)
paperqa/utils.py:218
- Ensure that the generic type 'T' is imported or defined (e.g., from typing import TypeVar; T = TypeVar('T')) to support generics in the run_or_ensure function.
def run_or_ensure(coro: Awaitable[T]) -> T | asyncio.Task[T]:
faee3ab to
aaeb64d
Compare
jamesbraza
force-pushed
the
better-docs-jupyter
branch
from
aaeb64d to
faf8df3
Compare
maykcaldas
approved these changes
May 21, 2025
| @@ -190,13 +192,13 @@ search over that index, then break the files into chunked evidence contexts, ran | |||
| All prior answers will be indexed and stored, you can view them by querying via the `search` subcommand, or access them yourself in your `PQA_HOME` directory, which defaults to `~/.pqa/`. | |||
|
|
|||
| ```bash | |||
| $ pqa search -i 'answers' 'antibodies' | |||
| pqa -i 'answers' search 'ranking and contextual summarization' | |||
There was a problem hiding this comment.
Do we know how many people uses the cli? Based on the issues, there are a few people who use it mainly for ollama queries.
I'm curious if we should focus on addressing those ~10 people comments
There was a problem hiding this comment.
Yeah let's address them, just in another PR if it's cool 😈
mskarlin
approved these changes
May 21, 2025
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.
@maykcaldas made a good comment here: #925 (comment)
This PR:
run_or_ensurefunction to allow both interpreter and Jupyter usageREADMEsnippets