fix: enable vale workflow correctly to review documentation changes #10211
+121
−46
Conversation
This file contains hidden or 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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| `CustomEmbedder` generates dense vector representations of text. The user can configure the model and its parameters during initialization. | ||
|
|
||
| This component supports multiple embedding providers, e.g. OpenAI, Cohere, and local models. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Google.Latin] Use 'for example' instead of 'e.g. '.
|
|
||
| ### In a Pipeline | ||
|
|
||
| Please initialize the embedder before adding it to a pipeline: |
Contributor
There was a problem hiding this comment.
[MyStyle.AvoidPlease] Avoid 'please' in instructions—it can make actions seem optional. Use imperative instead.
|
|
||
| | Parameter | Type | Default | Description | | ||
| | --- | --- | --- | --- | | ||
| | `model_name` | `str` | Required | The embedding model to utilize | |
Contributor
There was a problem hiding this comment.
[MyStyle.WordChoice] Use 'use' instead of 'utilize'.
| | `model_name` | `str` | Required | The embedding model to utilize | | ||
| | `batch_size` | `int` | `32` | Number of texts to process at once | | ||
|
|
||
| Export your configuration to a json file for reproducibility. |
Contributor
There was a problem hiding this comment.
[MyStyle.FileExtensions] Use uppercase for file extensions: 'JSON' → 'json'.
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.
Proposed Changes:
Fixing the Vale prose linter workflow that wasn't working due to configuration issues.
vale_flags: "--config=docs-website/.vale.ini"to point to the correct config file locationdocs-website/docs) to fix path parsing errorHow did you test it?
First experimented in #10210, you can see the final testing done in this PR below, with the Vale comments
Notes for the reviewer
This will be helpful for the engineering team to keep the documentation pages clean
Checklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:and added!in case the PR includes breaking changes.