Updating Developer Guide README.md to include Hybrid search specific documentation #955
Conversation
This file contains 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
adityabharadwaj198
temporarily deployed
to
marqo-test-suite
GitHub Actions
Inactive
Fixed numbering of the steps
Fixed numbering again
adityabharadwaj198
had a problem deploying
to
marqo-test-suite
GitHub Actions
Failure
farshidz
requested changes
Sep 11, 2024
adityabharadwaj198
added a commit
to adityabharadwaj198/marqo
that referenced
this pull request
Sep 12, 2024
This commit addresses comments made by @farshidz on PR: marqo-ai@544d33e. The commit also squashes previous 3 commits to keep the commit history clean Update README.md Fixed numbering again Update README.md Fixed numbering of the steps Updating Developer Guide README.md to include Hybrid search specific documentation
adityabharadwaj198
temporarily deployed
to
marqo-test-suite
GitHub Actions
Inactive
adityabharadwaj198
temporarily deployed
to
marqo-test-suite
GitHub Actions
Inactive
farshidz
temporarily deployed
to
marqo-test-suite
GitHub Actions
Inactive
farshidz
temporarily deployed
to
marqo-test-suite
GitHub Actions
Inactive
farshidz
temporarily deployed
to
marqo-test-suite
GitHub Actions
Inactive
farshidz
requested changes
Sep 19, 2024
src/marqo/README.md
Outdated
| ```bash | ||
| mvn -version | ||
| ``` | ||
| Post this you need to create a jar file, cd into the vespa directory in your local marqo repository, and run |
| mvn -version | ||
| ``` | ||
| Post this you need to create a jar file, cd into the vespa directory in your local marqo repository, and run | ||
| ```bash |
There was a problem hiding this comment.
added cd vespa in the line above
src/marqo/README.md
Outdated
| ```bash | ||
| mvn -version | ||
| ``` | ||
| Post this you need to create a jar file, cd into the vespa directory in your local marqo repository, and run |
There was a problem hiding this comment.
The wording is confusing. How do I create a jar file?
src/marqo/README.md
Outdated
| ### Option A. Run the Marqo application locally (outside of docker) through IDE | ||
| Now you can run Marqo locally through your IDE (e.g. PyCharm) by following the steps below. | ||
|
|
||
| 5. Open the Marqo project in your IDE (e.g. PyCharm) and go to the file `src/marqo/tensor_search/api.py` | ||
| 6. Set up your [debug configuration](https://www.jetbrains.com/help/pycharm/creating-run-debug-configuration-for-tests.html) | ||
| 6. Open the Marqo project in your IDE (e.g. PyCharm) and go to the file `src/marqo/tensor_search/api.py` |
There was a problem hiding this comment.
(e.g. PyCharm) once is enough. After that it's redundant
src/marqo/README.md
Outdated
| mvn clean package | ||
| ``` | ||
| Post running this command, you will see that a target folder gets created in the vespa directory, which contains a jar file called marqo-custom-searchers-deploy.jar. This jar file is used to deploy the custom searchers to Vespa. | ||
|
|
||
| ### Option A. Run the Marqo application locally (outside of docker) through IDE | ||
| Now you can run Marqo locally through your IDE (e.g. PyCharm) by following the steps below. |
src/marqo/README.md
Outdated
| @@ -52,14 +73,14 @@ VESPA_CONFIG_URL=http://localhost:19071 | |||
| VESPA_DOCUMENT_URL=http://localhost:8080 | |||
| VESPA_QUERY_URL=http://localhost:8080 | |||
| ``` | |||
| 7. Now you can Debug this file directly from your IDE (e.g. PyCharm) to start Marqo locally. | |||
| 8. Set breakpoints in the project for better debugging experience. | |||
| 8. Now you can Debug this file directly from your IDE (e.g. PyCharm) to start Marqo locally. | |||
Addressing comments on PR commit: ef985fd
adityabharadwaj198
temporarily deployed
to
marqo-test-suite
GitHub Actions
Inactive
adityabharadwaj198
temporarily deployed
to
marqo-test-suite
GitHub Actions
Inactive
adityabharadwaj198
temporarily deployed
to
marqo-test-suite
GitHub Actions
Inactive
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.
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
docs update
What is the current behavior? (You can also link to an open issue here)
Currently the developer guide readme doesn't contain steps to create the Vespa custom searcher's .jar file, which would lead to a contributor encountering issues when following the developer guide
What is the new behavior (if this is a feature change)?
Updated readme file contains the steps to create the .jar file.
Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
No
Have unit tests been run against this PR? (Has there also been any additional testing?)
Unit tests aren't required for the PR
Related Python client changes (link commit/PR here)
None
Related documentation changes (link commit/PR here)
None
Other information:
Please check if the PR fulfills these requirements