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

[Discussion][Good First Issue]: Verify different LLMs work with text_generation #259

Open
p-wysocki opened this issue Mar 1, 2024 · 6 comments
Assignees
Labels
good first issue Good for newcomers

Comments

@p-wysocki
Copy link
Collaborator

p-wysocki commented Mar 1, 2024

Context

This is an effort to increase Large Language Models tests coverage in OpenVINO GenAI.

Working on this task will let you familiarize yourself with:

  • C++ inference workflow
  • Different LLM models
  • GitHub Actions extension
  • Adding Python tests
  • And more

If you would like to add a new model which there's not a task for, please let us know! We would love to get outside ideas.

What needs to be done?

  1. Verify a model license is compatible with OpenVINO.GenAI's license. The model must have LICENSE file or specify a license tag in its repo. For example, https://huggingface.co/TinyLlama/TinyLlama-1.1B-Chat-v1.0/tree/main doesn't have the file, but has the tag License: apache-2.0. Apache 2.0 and MIT licenses are compatible with OpenVINO.GenAI's license. For any other license, please, ask in the corresponding Good First Issue if the given license is compatible. If the model's repo doesn't have a license, contact the authors asking to add it by starting a new discussion at model's repo.
  2. Try running an LLM specified in your specific task with every sample form https://github.com/openvinotoolkit/openvino.genai/tree/master/samples and tools from https://github.com/openvinotoolkit/openvino.genai/tree/master/tools/continuous_batching. Install GenAi following https://github.com/openvinotoolkit/openvino.genai/blob/master/src/docs/BUILD.md. Perform Option 2 - setting paths to built OpenVINO GenAI artifacts manually instead of cmake option because not every sample is installed yet.
  3. If it doesn't fail and outputs a reasonable responce, the PR should be submitted to extend the supported models list.
  4. If the model is small enough to fit into the default GitHub Actions runner, add the model to tests here.
  5. If the comparison against python transformers fails it's worth adding a test for the model anyway, just without comparison against python, leave a comment in workflow code if this is the case. Since default runners are available for everyone, one can verify the test passes by opening a PR in their fork first.
  6. Extend the nightly_models list with the given model and run nightly tests for that model: https://github.com/openvinotoolkit/openvino.genai/tree/master/tests/python_tests#customise-tests-run. Report if there are failing tests and comment out the model in the nightly_models list. Add this change to your pull request (PR).

Example Pull Requests

Example commit: bf4c200#diff-2c8a6fc2893aa2e1103985c1ee763cc325de6042ea66a11ae30428d77e73e416

Resources

List of tasks in the effort

Expand me

Contact points

@Wovchena

Ticket

134074

@p-wysocki p-wysocki added the good first issue Good for newcomers label Mar 1, 2024
@github-project-automation github-project-automation bot moved this to Contributors Needed in Good first issues Mar 1, 2024
@qxprakash qxprakash mentioned this issue Mar 12, 2024
pavel-esir pushed a commit that referenced this issue Mar 13, 2024
This should close #271 , I have updated the model list and added tests
with reference from #259

---------

Signed-off-by: Lim, Kuan Xian <kuan.xian.lim@intel.com>
Copy link

github-actions bot commented May 5, 2024

Thank you for looking into this issue! Please let us know if you have any questions or require any help.

@hegdeadithyak hegdeadithyak removed their assignment May 10, 2024
@Jessielovecodings
Copy link

#WLB
.take

Copy link

github-actions bot commented Jun 3, 2024

Thank you for looking into this issue! Please let us know if you have any questions or require any help.

@kuanxian1
Copy link
Contributor

Most of the files linked here are not found, would be great if anyone could update it, thanks!

@p-wysocki
Copy link
Collaborator Author

Hello @kuanxian1, thanks for pointing our attention to it. @Wovchena I think the links are on openvino_notebooks repository, do you know who we could ask for an update?

@Wovchena
Copy link
Collaborator

I updated this issue description.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

5 participants