Skip to content

Conversation

@jbaross-pometry
Copy link
Contributor

What changes were proposed in this pull request?

  • Updated docstrings for raphtory/src/python/packages/vectors.rs and raphtory/src/python/types/wrappers/document.rs for clarity and grammar.
  • Added a userguide page to describe the vertor tools at a conceptual level
  • Added a simple example of retriving results and feeding into an LLM
    • This example isn't great becuse I didn't have rich data to demo the templates with or ask more interesting queries.
    • Template strings also seem to break mkdocs when included in code fences

It looks like some things have been renamed or reworked in the https://github.com/Pometry/Raphtory/pull/2249/files PR so any feedback to align these would be helpful

@jbaross-pometry jbaross-pometry added the Documentation Changes which need to be made to our documentation label Oct 28, 2025
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark 'GraphQL Benchmark'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 2.

Benchmark suite Current: dbfe0e7 Previous: 675dfd2 Ratio
addNode 0 req/s 1314 req/s +∞

This comment was automatically generated by workflow using github-action-benchmark.

Copy link
Collaborator

@ricopinazo ricopinazo left a comment

Choose a reason for hiding this comment

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

Everything looks good overall, I like the vectorisation page, just left a few comments that might be worth addressing now since they refer to things that are not going to change in a foreseeable future

Copy link
Collaborator

@ricopinazo ricopinazo left a comment

Choose a reason for hiding this comment

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

LGTM

@jbaross-pometry jbaross-pometry merged commit ca869cb into master Nov 27, 2025
33 of 34 checks passed
@jbaross-pometry jbaross-pometry deleted the james/vectors branch November 27, 2025 17:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Changes which need to be made to our documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants