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

Document automated checks under o!TR/Data Processing/Automated Checks #30

Open
wants to merge 18 commits into
base: master
Choose a base branch
from

Conversation

hburn7
Copy link
Contributor

@hburn7 hburn7 commented Nov 29, 2024

  • Documents automation checks flow for all entities.
  • Documents VerificationStatus, ProcessingStatus, and RejectionReason.
  • Explains our core fundamentals when designing this system.
  • Includes a small FAQ

@hburn7 hburn7 added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 29, 2024
@hburn7 hburn7 requested review from myssto and cytusine0 November 29, 2024 19:22
Copy link
Contributor

@cytusine0 cytusine0 left a comment

Choose a reason for hiding this comment

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

myssto your turn

the CO23 example is probably useful illustration, I wonder if there are other parts of this that could also use an example

docs/topics/Automated-Checks.md Outdated Show resolved Hide resolved
docs/topics/Automated-Checks.md Outdated Show resolved Hide resolved
docs/topics/Automated-Checks.md Outdated Show resolved Hide resolved
docs/topics/Automated-Checks.md Outdated Show resolved Hide resolved
docs/topics/Automated-Checks.md Outdated Show resolved Hide resolved
docs/topics/Automated-Checks.md Show resolved Hide resolved
docs/topics/Automated-Checks.md Outdated Show resolved Hide resolved
docs/topics/Automated-Checks.md Outdated Show resolved Hide resolved
docs/topics/Score-Modifications.md Show resolved Hide resolved
docs/topics/Automated-Checks.md Outdated Show resolved Hide resolved
docs/topics/Related-Services.md Outdated Show resolved Hide resolved
docs/topics/Automated-Checks.md Show resolved Hide resolved
hburn7 and others added 4 commits November 29, 2024 16:16
Co-authored-by: cytusine0 <139372927+cytusine0@users.noreply.github.com>
…-checks

# Conflicts:
#	docs/topics/Automated-Checks.md
docs/topics/Automated-Checks.md Outdated Show resolved Hide resolved
docs/topics/Automated-Checks.md Outdated Show resolved Hide resolved
Comment on lines 245 to 251
### How can a human manually mark all entities as `Verified`?

Most of the issues which require manual intervention are at the `Match` and `Game` levels. For example, if a `Match` has too many invalid games, it will be marked as `PreRejected` and require manual intervention. The same is true for `Game`s.

For `GameScore` entities, there are very concrete rules which can easily determine whether it should be `Rejected`, for example if the `Score` value is below the minimum (and thus very likely comes from a referee in the lobby or other anomaly).

We also have a web interface which allows reviewers to mark an entity - and all of its children - as `Verified` or `Rejected`. Generally speaking, if at a glance everything is marked as `PreVerified`, very little effort is required to manually approve these submissions. If the opposite is true, it's likely that the submission contains invalid data.
Copy link

Choose a reason for hiding this comment

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

I'm not the best with wording but this section reads a bit odd to me

Copy link

Choose a reason for hiding this comment

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

Most of the issues which require manual intervention are at the Match and Game levels. For example, if a Match has too many invalid games, it will be marked as PreRejected and require manual intervention. The same is true for Games.

I think I dislike the usage of "require manual intervention" as if anything doesn't require manual intervention? Items have to be manually verified or rejected in some capacity regardless of their existing verification status

Copy link

Choose a reason for hiding this comment

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

For GameScore entities, there are very concrete rules which can easily determine whether it should be Rejected, for example if the Score value is below the minimum (and thus very likely comes from a referee in the lobby or other anomaly).

This "For GameScore entities, there are very concrete rules which can easily determine whether it should be Rejected" implies that what follows will be some sort of guide for how to review GameScores, but then you describe the criteria for the GameScoreCheck, which results in a pre rejection?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Basically in this section I'm attempting to state how 'easy' it is for reviewers to not have to comb through millions of scores. I'll try to reword.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Reworded, please let me know your thoughts. @myssto

@hburn7 hburn7 requested review from myssto and cytusine0 December 2, 2024 20:00
Copy link
Contributor

@cytusine0 cytusine0 left a comment

Choose a reason for hiding this comment

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

small things ™️

docs/topics/DataWorkerService.md Outdated Show resolved Hide resolved
docs/topics/DataWorkerService.md Outdated Show resolved Hide resolved
docs/topics/DataWorkerService.md Outdated Show resolved Hide resolved
docs/topics/o-TR-Processor.md Outdated Show resolved Hide resolved
@hburn7 hburn7 requested a review from cytusine0 December 4, 2024 20:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request size/L
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants