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

Add Playground Expert Evaluation Docs #392

Open
wants to merge 8 commits into
base: develop
Choose a base branch
from

Conversation

laadvo
Copy link
Contributor

@laadvo laadvo commented Jan 14, 2025

Motivation and Context

We want to extend the playground documentation to include description of Expert Evaluation and the Side-by-Side tool added in this PR. We want to be able to run expert evaluations in the future and for that documentation is necessary.

Description

A new section "Expert Evaluation" has been added to the playground documentation. The two views: Researcher View and Expert View are now described in some detail with the addition of pictures and videos.

Steps for Testing

Access the documentation here. Scroll to the Artifacts section of the page below and download the documentation. Open overview>playground.html in your browser, scrol to the Expert Evaluation section. Read through the newly added documentation and make sure it makes sense and that it is understandable.

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.


Screenshots

@laadvo laadvo marked this pull request as ready for review January 21, 2025 10:22
EneaGore
EneaGore previously approved these changes Jan 28, 2025
Copy link
Contributor

@EneaGore EneaGore left a comment

Choose a reason for hiding this comment

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

Looks great overall, added some small nitpicks that could improve readability imo.

docs/overview/playground.rst Outdated Show resolved Hide resolved
docs/overview/playground.rst Outdated Show resolved Hide resolved
docs/overview/playground.rst Outdated Show resolved Hide resolved
docs/overview/playground.rst Outdated Show resolved Hide resolved
docs/overview/playground.rst Outdated Show resolved Hide resolved
docs/overview/playground.rst Outdated Show resolved Hide resolved
docs/overview/playground.rst Outdated Show resolved Hide resolved
docs/overview/playground.rst Outdated Show resolved Hide resolved
docs/overview/playground.rst Outdated Show resolved Hide resolved
docs/overview/playground.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@EneaGore EneaGore left a comment

Choose a reason for hiding this comment

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

Thanks for applying the suggestions.

Copy link

@ahmetsenturk ahmetsenturk 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 and pretty elaborative 👍

@maximiliansoelch maximiliansoelch added the deploy:athena-test2 Athena Test Server 2 label Jan 30, 2025
@maximiliansoelch maximiliansoelch temporarily deployed to athena-test2.ase.cit.tum.de January 30, 2025 16:43 — with GitHub Actions Inactive
@github-actions github-actions bot added lock:athena-test2 Is currently deployed to Athena Test Server 2 and removed deploy:athena-test2 Athena Test Server 2 labels Jan 30, 2025
@maximiliansoelch maximiliansoelch added the deploy:athena-test1 Athena Test Server 1 label Jan 30, 2025
@maximiliansoelch maximiliansoelch temporarily deployed to athena-test1.ase.cit.tum.de January 30, 2025 16:50 — with GitHub Actions Inactive
@github-actions github-actions bot removed the deploy:athena-test1 Athena Test Server 1 label Jan 30, 2025
@maximiliansoelch maximiliansoelch added deploy:athena-test1 Athena Test Server 1 and removed lock:athena-test2 Is currently deployed to Athena Test Server 2 deploy:athena-test1 Athena Test Server 1 labels Jan 30, 2025
@github-actions github-actions bot added the lock:athena-test1 Is currently deployed to Athena Test Server 1 label Jan 30, 2025
@maximiliansoelch maximiliansoelch removed the lock:athena-test1 Is currently deployed to Athena Test Server 1 label Jan 30, 2025
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.

5 participants