Skip to content

[DOC] Add collection config docs #4300

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 1 commit into from
Apr 18, 2025
Merged

[DOC] Add collection config docs #4300

merged 1 commit into from
Apr 18, 2025

Conversation

jairad26
Copy link
Contributor

@jairad26 jairad26 commented Apr 16, 2025

Description of changes

This PR adds documentation for how to configure collection configuration, settings hnsw parameters, and embedding functions

Test plan

How are these changes tested?

  • Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs repository?

Copy link

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

@jairad26 jairad26 marked this pull request as ready for review April 16, 2025 21:05
@jairad26 jairad26 force-pushed the jai/js-coll-config branch from 7ed7749 to 994001f Compare April 16, 2025 21:22
@jairad26 jairad26 force-pushed the jai/coll-config-docs branch from 85c75e4 to 6cbd3a6 Compare April 16, 2025 21:22
@jairad26 jairad26 force-pushed the jai/coll-config-docs branch from 6cbd3a6 to 4336cf8 Compare April 16, 2025 21:35
@jairad26 jairad26 force-pushed the jai/js-coll-config branch from 994001f to cb952e2 Compare April 16, 2025 21:35
@jairad26 jairad26 force-pushed the jai/coll-config-docs branch from 4336cf8 to 64dd009 Compare April 17, 2025 18:34
@jairad26 jairad26 force-pushed the jai/js-coll-config branch from cb952e2 to f46a640 Compare April 17, 2025 18:34
@jairad26 jairad26 force-pushed the jai/js-coll-config branch from f46a640 to 2ba2d00 Compare April 17, 2025 20:09
@jairad26 jairad26 force-pushed the jai/coll-config-docs branch from 64dd009 to 27f6b0d Compare April 17, 2025 20:09
@jairad26 jairad26 force-pushed the jai/js-coll-config branch from 2ba2d00 to cabc70d Compare April 17, 2025 21:33
@jairad26 jairad26 force-pushed the jai/coll-config-docs branch from 27f6b0d to 96b3298 Compare April 17, 2025 21:33
@jairad26 jairad26 force-pushed the jai/coll-config-docs branch from 96b3298 to b4aabe1 Compare April 17, 2025 21:38
@jairad26 jairad26 force-pushed the jai/js-coll-config branch from cabc70d to 69958a4 Compare April 17, 2025 21:38
@jairad26 jairad26 force-pushed the jai/js-coll-config branch from 69958a4 to 8827040 Compare April 17, 2025 21:42
@jairad26 jairad26 force-pushed the jai/coll-config-docs branch from b4aabe1 to 096a38a Compare April 17, 2025 21:42
@jairad26 jairad26 force-pushed the jai/coll-config-docs branch from 096a38a to f9a5eca Compare April 17, 2025 21:48
@jairad26 jairad26 force-pushed the jai/coll-config-docs branch from f9a5eca to 74db38f Compare April 17, 2025 22:07
@jairad26 jairad26 force-pushed the jai/js-coll-config branch from 7948fc7 to 2f333dc Compare April 17, 2025 22:07
@jairad26 jairad26 force-pushed the jai/coll-config-docs branch from 74db38f to 04a5ca9 Compare April 18, 2025 00:32
@jairad26 jairad26 force-pushed the jai/js-coll-config branch from 2f333dc to 87d1b56 Compare April 18, 2025 00:32
@jairad26 jairad26 force-pushed the jai/js-coll-config branch from 87d1b56 to f8328d7 Compare April 18, 2025 01:29
@jairad26 jairad26 force-pushed the jai/coll-config-docs branch from 04a5ca9 to 56ff6e9 Compare April 18, 2025 01:29
@jairad26 jairad26 changed the base branch from jai/js-coll-config to graphite-base/4300 April 18, 2025 02:46
@jairad26 jairad26 changed the base branch from graphite-base/4300 to main April 18, 2025 02:47
Copy link
Contributor Author

Merge activity

  • Apr 17, 10:48 PM EDT: Graphite rebased this pull request as part of a merge.

@jairad26 jairad26 merged commit 52655c8 into main Apr 18, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant