Skip to content

Conversation

guspan-tanadi
Copy link

@guspan-tanadi guspan-tanadi commented Apr 18, 2025

Important

Update documentation links for training scripts and correct a URL typo.

  • Documentation Updates:
    • Update training script paths in finetune-embedding.md for Duplicate Text Classification and Information Retrieval tasks.
    • Correct typo in URL for contrastive loss explanation in finetune-embedding.md.
    • Update OpenAI Embeddings URL in index.md to correct path.

This description was created by Ellipsis for 1cf34f9. It will automatically update as commits are pushed.

Copy link

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Reviewed everything up to 1cf34f9 in 1 minute and 17 seconds

More details
  • Looked at 64 lines of code in 2 files
  • Skipped 0 files when reviewing.
  • Skipped posting 14 drafted comments based on config settings.
1. docs/finetune-embedding.md:26
  • Draft comment:
    Updated source URL path to 'sentence_transformer/training' reflects new repo structure. Verify file organization.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 85%
    The comment asks the PR author to verify the file organization after a change, which is against the rules as it asks for confirmation or verification. It doesn't provide a specific suggestion or point out a specific issue.
2. docs/finetune-embedding.md:27
  • Draft comment:
    Updated Information Retrieval source URL adapted to new folder structure.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 85%
    This comment is purely informative and does not provide any actionable feedback or suggestions for improvement. It simply states what was done without offering any insight or guidance.
3. docs/finetune-embedding.md:118
  • Draft comment:
    Fixed typo in link anchor from '#constrative-loss' to '#contrastive-loss'.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 85%
    This comment is purely informative, as it only states that a typo in a link anchor was fixed. It does not provide any actionable feedback or suggestions for improvement.
4. docs/finetune-embedding.md:132
  • Draft comment:
    Updated BinaryClassificationEvaluator code link to new line numbers (L60-L71).
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 85%
    This comment is purely informative, as it only mentions an update to line numbers in a code link. It does not provide any actionable feedback or suggestions for improvement.
5. docs/finetune-embedding.md:218
  • Draft comment:
    Updated table links in the task summary section for consistency with new repo structure.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 85%
    This comment is purely informative and does not provide any actionable feedback or suggestions for improvement. It simply states what was done without offering any insight or guidance.
6. docs/index.md:11
  • Draft comment:
    Updated OpenAI Embeddings link to reflect the latest API reference on platform.openai.com.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 85%
    This comment is purely informative and does not provide any actionable feedback or suggestions for improvement. It simply states what was done without offering any insight or guidance.
7. docs/finetune-embedding.md:24
  • Draft comment:
    Updated example script paths in the tasks table. Confirm that the new 'sentence_transformer' directory structure is correct.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 85%
    The comment is asking the PR author to confirm the directory structure, which violates the rule against asking for confirmation of intentions. It doesn't provide a specific suggestion or point out a potential issue with the code.
8. docs/finetune-embedding.md:115
  • Draft comment:
    Fixed typo in loss link anchor from 'constrative-loss' to 'contrastive-loss'.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 85%
    This comment is purely informative, indicating a typo fix in a link anchor. It doesn't provide any actionable feedback or suggestions for improvement. According to the rules, purely informative comments should be removed.
9. docs/finetune-embedding.md:129
  • Draft comment:
    Updated BinaryClassificationEvaluator source link and line anchor (now L60-L71). Verify the new reference is correct.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 85%
    This comment is asking the PR author to verify the correctness of a change, which is against the rules. It doesn't provide a specific suggestion or point out a specific issue with the code.
10. docs/finetune-embedding.md:215
  • Draft comment:
    Updated example script paths in the bottom tasks table. Ensure consistency with repository structure.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 85%
    This comment is purely informative and asks the PR author to ensure consistency, which violates the rules. It doesn't provide a specific suggestion or point out a specific issue with the code.
11. docs/index.md:11
  • Draft comment:
    Updated OpenAI Embeddings link to the latest API reference; please verify the new URL.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 85%
    This comment is asking the PR author to verify a URL change, which falls under the rule of not asking the author to confirm or verify things. It doesn't provide a specific code suggestion or highlight a potential issue with the code itself.
12. docs/finetune-embedding.md:177
  • Draft comment:
    Typo: 'Sentenece Transformer' should be corrected to 'Sentence Transformer'.
  • Reason this comment was not posted:
    Comment was not on a location in the diff, so it can't be submitted as a review comment.
13. docs/finetune-embedding.md:239
  • Draft comment:
    Typo: 'trainig data' should be corrected to 'training data'.
  • Reason this comment was not posted:
    Comment was not on a location in the diff, so it can't be submitted as a review comment.
14. docs/finetune-embedding.md:218
  • Draft comment:
    Lexicographical Suggestion: In the table for Duplicate Text Classification, consider revising 'Pairs of text that are may or may not be duplicate' to 'Pairs of text that may or may not be duplicates' for improved clarity.
  • Reason this comment was not posted:
    Comment was on unchanged code.

Workflow ID: wflow_qXXBplJvXXIEXKKc


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

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