Skip to content
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

fix: correct link for README and add a note for long-run jobs #1654

Merged
merged 3 commits into from
Jan 24, 2025

Conversation

kazunori279
Copy link
Contributor

Corrected the link on the README, and added a note for long-run jobs.

fixed, the link and reordering.
added a note for long-run jobs
@kazunori279 kazunori279 requested a review from a team as a code owner January 24, 2025 07:31
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link
Contributor

@code-review-assist code-review-assist bot left a comment

Choose a reason for hiding this comment

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

Hi team,

I'm currently reviewing this pull request and will provide my feedback shortly. In the meantime, here's a summary for you and other reviewers to quickly get up to speed:

This pull request by @kazunori279 aims to fix a broken link in the README.md file and add a helpful note for users running long jobs.

Changes:

  • embeddings/README.md: The links to the notebooks have been reordered and corrected. Specifically, lines 19-26 were modified to correct the order and names of the notebooks listed. The old links were:

    • generate-embs-for-vvs.ipynb
    • hybrid-search.ipynb
    • embedding-similarity-visualization.ipynb
    • intro-textemb-vectorsearch.ipynb
    • vector-search-quickstart.ipynb
    • intro_multimodal_embeddings.ipynb
    • intro_embeddings_tuning.ipynb
    • task-type-embedding.ipynb

    The new links are:

    • vector-search-quickstart.ipynb
    • intro-textemb-vectorsearch.ipynb
    • hybrid-search.ipynb
    • embedding-similarity-visualization.ipynb
    • intro_multimodal_embeddings.ipynb
    • intro_embeddings_tuning.ipynb
    • task-type-embedding.ipynb
    • large-embs-generation-for-vvs.ipynb
  • embeddings/large-embs-generation-for-vvs.ipynb: A new section (lines 740-751) has been added to provide tips for running long jobs, recommending users convert the notebook to a .py file and use the nohup command to prevent connection issues.

Intent:

The primary goal is to improve the user experience by providing accurate links in the README and offering guidance for handling long-running processes.

I'll be back with a full review soon!


A little haiku to lighten the mood:

Code flows like a stream,
Fixes merge, a gentle hum,
Progress finds its way.

Copy link
Contributor

@code-review-assist code-review-assist bot left a comment

Choose a reason for hiding this comment

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

This pull request corrects a broken link in the README and adds a helpful note about running long jobs in the large-embs-generation-for-vvs.ipynb notebook. The changes are well-intentioned and improve the documentation and user experience. However, there are a few minor suggestions to further enhance clarity and consistency.

embeddings/README.md Show resolved Hide resolved
@holtskinner holtskinner merged commit 15681ef into main Jan 24, 2025
10 checks passed
@holtskinner holtskinner deleted the kaz-patch-0124 branch January 24, 2025 15:57
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.

2 participants