Skip to content

Draft quality warning - #64

Open
bhartmoore wants to merge 6 commits into
masterfrom
draft_quality_warning
Open

bhartmoore wants to merge 6 commits into
masterfrom
draft_quality_warning

Conversation

@bhartmoore

Copy link
Copy Markdown
Collaborator

Create help text and add to FAQ section to explain draft quality warnings.

@github-actions

github-actions Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

🚀 Preview deployed!

You can preview this PR at: https://pr-64--sf-help-preview.netlify.app

1 similar comment
@github-actions

github-actions Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

🚀 Preview deployed!

You can preview this PR at: https://pr-64--sf-help-preview.netlify.app


Only human translators can decide whether a draft serves a team’s needs. However, it is helpful to understand some factors that can influence the quality of a generated draft.

- Amount and quality of training data (language examples)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think it would be helpful to emphasize we're talking about paired data. If a user is reading this and doesn't already understand that concept that more training data is generally better, they almost certainly don't understand the need for training data to be paired.

- A closer linguistic relationship and typological match often results in better draft quality.
- Relationship between source text and target texts
- When the translation closely follows the words of the reference text, this can make model training more successful and improve draft quality.
- For this reason, including a back translation in the source language as a second reference text may improve quality.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

"For this reason" makes it feel like it's a continuation of the point above. Maybe that's OK and better than one really long point?

It seems like using a back translation as a reference may be a confusing concept and might warrant an FAQ entry that we link to.

- When the translation closely follows the words of the reference text, this can make model training more successful and improve draft quality.
- For this reason, including a back translation in the source language as a second reference text may improve quality.
- Representation of source language in the language model
- Using a high-resource source language, that is, one which is a major modern language and has plentiful examples in the underlying language model, can improve draft quality.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Maybe parentheses instead of "that is"? It seems like it would make it easier to parse the sentence.

slug: /understanding-draft-quality
---

## Elements of Draft Quality

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The title says "Elements of Draft Quality", but I think it's really more so "factors that impact quality".

I think "elements of" would be things like word choice, naturalness, accuracy, spelling, punctuation, etc.


Here are some ideas to improve draft quality. Not all of these will be possible or relevant for all projects.
- Use as much translated Scripture text as possible for training the model.
- Consider adding parallel linguistic data in the source and target languages.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Maybe word this in a way that suggests how, such as "including files with paired sentences" rather than "parallel linguistic data"? It feels like less jargon, and also implies how it's done.


## Draft Quality Warning {#9a12a839f3634e75acd511f4b426eb86}

Scripture Forge uses automated scoring to estimate draft quality, and will present a warning to users if the estimated quality of a generated draft is very low. This may indicate that there is an error in the configuration that resulted in unsuccessful model training. Please see the FAQ for more information. Some drafts may be low quality even if they are not flagged by the warning. It is important to check the quality of each draft carefully.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

We'll need to make sure we don't publish this until this feature goes live. Probably won't be a problem as that's likely next week. Just leaving this as a note so I don't forget.

@@ -0,0 +1,40 @@
---
title: Understanding Draft Quality

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I wonder if "Improving Draft Quality" might be a better title?

I know the "understanding" wording mirrors the "Understanding Draft Generation" title I wrote, but I can't really think of any alternative way to title that document; it's very much a "how it works" document, rather than a "things to try" document.

@@ -0,0 +1,40 @@
---
title: Understanding Draft Quality
sidebar_position: 1

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Is this where you are intending to make the document land in the sidebar?

Image

- A script unknown to the underlying language model may decrease draft quality.
- Agglutinative languages or those without word breaks may experience decreased draft quality.
- A project that translates at the paragraph level, uses many long verse ranges, or includes significant explication not found in the source text may see decreased draft quality.

@Nateowami Nateowami Sep 10, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I wonder if this might be more readable if the sections were minor headings instead of bullet points? What do you think?

What it currently looks like

Image

Alternate example A

Image

Alternate example B

Image

Comment thread docs/faq.md

_Remember that draft quality is only an estimate and may not reflect human judgment. Please review the draft carefully to determine whether it is useful in your translation work. The help text about [Understanding Draft Quality](https://help.scriptureforge.org/understanding-draft-quality) may be helpful._

_If draft quality is still low after completing the recommended checks, you may need to translate more text before generating a draft. Early in a translation project, the choice of which book to draft next is important. For example, a model trained on the book of Luke is better prepared to draft Mark than to draft Romans. If you are working in the New Testament, please review the [Guidelines for New Testament Draft Generation](https://help.scriptureforge.org/new-testament-drafting) to learn about how book sequence can affect draft quality._

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Maybe also suggest reaching out for help?

@Nateowami Nateowami left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Sorry for so many comments.

Comment thread docs/faq.md

2. Why do I still see a low draft quality warning after completing all the checks?

_Remember that draft quality is only an estimate and may not reflect human judgment. Please review the draft carefully to determine whether it is useful in your translation work. The help text about [Understanding Draft Quality](https://help.scriptureforge.org/understanding-draft-quality) may be helpful._

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

draft quality is only an estimate

I think it's supposed to say something like "the warning is based on an estimate".

Comment thread docs/faq.md
- _Language codes: Does the language code for each reference and source project match the text of that project?_
- _You can update language codes in Paratext under “Project properties.”_
- _Draft Books: Are the book or books to draft selected in Step 2, “Select books to draft”?_
- _Training Books: Are all the completed and checked books in the project selected in Step 3, “Select books to train on”?_

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This seems to be missing any note about making sure the reference text training data has content and is selected. We auto select it when you select target books, but it's possible for it to be essentially blank.

@@ -0,0 +1 @@

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think this file was created by accident.

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