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

Adding documentation for LLM feature #239

Merged
merged 4 commits into from
May 3, 2024
Merged

Adding documentation for LLM feature #239

merged 4 commits into from
May 3, 2024

Conversation

ayanaar
Copy link
Contributor

@ayanaar ayanaar commented May 1, 2024

Addresses issue #238

@ayanaar ayanaar requested a review from a team as a code owner May 1, 2024 18:52
@ayanaar ayanaar requested a review from flodolo May 1, 2024 18:52
@@ -191,6 +191,23 @@ The origin of the machinery entry is listed in gray above the source string. Cli

Be careful when using the machinery tab as suggestions may not match the source string for the project being translated. Even if the source strings match, the context in which strings are used may not be the same. This could lead to incorrect or unnatural translations. Always keep the meaning and purpose of the string being translated in mind when using the machinery tab.

#### Large language model (LLM) integration

For all locales that use Google Translate as a translation source, a dropdown labeled `AI` becomes available. This feature refines the Google Translate output using a LLM. Collapsing this dropdown will reveal three options:
Copy link
Contributor

Choose a reason for hiding this comment

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

... using an LLM.

@@ -191,6 +191,23 @@ The origin of the machinery entry is listed in gray above the source string. Cli

Be careful when using the machinery tab as suggestions may not match the source string for the project being translated. Even if the source strings match, the context in which strings are used may not be the same. This could lead to incorrect or unnatural translations. Always keep the meaning and purpose of the string being translated in mind when using the machinery tab.

#### Large language model (LLM) integration

For all locales that use Google Translate as a translation source, a dropdown labeled `AI` becomes available. This feature refines the Google Translate output using an LLM. Collapsing this dropdown will reveal three options:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
For all locales that use Google Translate as a translation source, a dropdown labeled `AI` becomes available. This feature refines the Google Translate output using an LLM. Collapsing this dropdown will reveal three options:
Pontoon will show a dropdown labeled `AI` for all locales that have Google Translate available as a translation source. This feature refines the Google Translate output using an LLM. Opening this dropdown will reveal three options:

* `MAKE FORMAL`: Generate a more formal version of this translation.
* `MAKE INFORMAL`: Generate a more informal version of this translation.

After selecting an option, the revised translation will replace the original suggestion. Once a new translation is generated, another option `SHOW ORIGINAL` will be seen in the dropdown menu. You can revert to the original translation by selecting the `SHOW ORIGINAL` option from the dropdown menu.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
After selecting an option, the revised translation will replace the original suggestion. Once a new translation is generated, another option `SHOW ORIGINAL` will be seen in the dropdown menu. You can revert to the original translation by selecting the `SHOW ORIGINAL` option from the dropdown menu.
After selecting an option, the revised translation will replace the original suggestion. Once a new translation is generated, another option `SHOW ORIGINAL` will be available in the dropdown menu. Selecting it will revert to the original suggestion.


![Dropdown to use the LLM feature](../../assets/images/pontoon/ui/llm_dropdown.png "Screenshot of the dropdown to use the LLM feature")

The screenshot above displays the dropdown to use the LLM feature.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would drop these descriptions of the screenshots (they're already in the alt text).

You can put the first screenshot after the list, before the SHOW original paragraph.

@flodolo
Copy link
Contributor

flodolo commented May 2, 2024

Also, don't forget to optimize the images.

@flodolo flodolo merged commit 30ca8bf into main May 3, 2024
2 checks passed
@flodolo flodolo deleted the LLM-feature branch May 3, 2024 14:28
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.

3 participants