Skip to content

Add Developer guide #46

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 7 commits into from
Apr 11, 2025
Merged

Conversation

Rajrahane
Copy link
Member

@Rajrahane Rajrahane commented Apr 2, 2025

Description

Add Developer Guide

  • Fork and Clone
  • Dependency installs
  • Python Guide
    • Formatting and Linting: black and flake8
    • Testing: mypy and pytest
  • Memory Profiling
    • GPU with nvidia_smi
    • CPU with memory_profiler
  • Building Docker Images
    • Building Faiss Image: Mention git submodule init in repo + docker build cmd from root folder
    • Building Core Image: Docker cmd from root folder

https://github.com/Rajrahane/remote-vector-index-builder/blob/dev-guide/DEVELOPER_GUIDE.md
Visual Representation

Issues Resolved

Partly solves #2

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@Rajrahane
Copy link
Member Author

@Rajrahane Rajrahane marked this pull request as ready for review April 2, 2025 19:14
Copy link
Collaborator

@owenhalpert owenhalpert left a comment

Choose a reason for hiding this comment

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

Thanks, I have some comments on typos and formatting. In addition to these comments, please try to be consistent with how you end the sentences that come right before code blocks. In k-NN, you can see how most either end with a period or a colon, like "To do X, run:" or "add the
@Profile annotation."

@Rajrahane Rajrahane force-pushed the dev-guide branch 5 times, most recently from f7d56e7 to 74fd126 Compare April 3, 2025 00:00
@Rajrahane Rajrahane added the documentation Improvements or additions to documentation label Apr 7, 2025
Signed-off-by: Rajvaibhav Rahane <[email protected]>
rchitale7
rchitale7 previously approved these changes Apr 8, 2025
@rchitale7
Copy link
Member

Some small comments left from me - I plan on adding the API image docs to this guide afterwards, so I can make these changes in a follow up PR.

@owenhalpert
Copy link
Collaborator

Two small comments, otherwise looks good to me

Signed-off-by: Rajvaibhav Rahane <[email protected]>
Copy link
Collaborator

@owenhalpert owenhalpert left a comment

Choose a reason for hiding this comment

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

Should be my final nits, thank you!

Signed-off-by: Rajvaibhav Rahane <[email protected]>
@Rajrahane Rajrahane merged commit a922f0a into opensearch-project:main Apr 11, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants