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

Tests: Expand docs. #154

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Tests: Expand docs. #154

wants to merge 4 commits into from

Conversation

kkeroo
Copy link
Collaborator

@kkeroo kkeroo commented Dec 20, 2024

This PR expands Readmes in E2E and Integration tests so the required parameters are described.

@kkeroo kkeroo requested a review from aljazkonec1 December 20, 2024 12:45
@github-actions github-actions bot added documentation Improvements or additions to documentation tests Changes affecting tests labels Dec 20, 2024
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.16%. Comparing base (97ef45a) to head (7cbe858).

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #154      +/-   ##
==========================================
+ Coverage   36.15%   36.16%   +0.01%     
==========================================
  Files          70       70              
  Lines        3986     3987       +1     
==========================================
+ Hits         1441     1442       +1     
  Misses       2545     2545              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


There are 4 required parameters that need to be set when triggering the Github action:

- `additional-parameter`: The parameter that specifies the desired test. Default is `-all` which runs tests on all public models. The available options are: `-all`, `-p <parser_name>`, `-s <slug_1> <slug_2> ...`.
Copy link
Collaborator

@jkbmrz jkbmrz Dec 20, 2024

Choose a reason for hiding this comment

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

slug should be renamed to model (or HubAI model identifier). I'd also fix the argument call from -s to -m (model)

Copy link
Contributor

@aljazkonec1 aljazkonec1 left a comment

Choose a reason for hiding this comment

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

LGTM, just what @jkbmrz mentioned

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 tests Changes affecting tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants