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

docs: swapped modeltype to str, connected prompts to files #62

Merged
merged 3 commits into from
Jun 30, 2023

Conversation

jayolee
Copy link
Contributor

@jayolee jayolee commented Jun 28, 2023

Status

READY

Description

  • Swapped ModelType enums to str on examples and README
  • Connected annex files to the existing files under prompts
  • Connected a prompt example to the example file
  • Swapped not supported model name
  • Updated API Endpoint explanation on README
  • Updated param details of GenerateParams to explain invalid options for greedy decoding method

Impacted Areas in Library

Which issue(s) does this pull-request fix?

Contributes to: #24

Any special notes for your reviewer?

We'll update the prompt section so replaced only one example to literalinclude
Below shows the differences:
existing one
Screenshot 2023-06-28 at 11 13 00 am

literalinclude ver
Screenshot 2023-06-28 at 11 24 02 am


Checklist

  • Automated tests exist
  • Updated Package Requirements (if required, and with maintainers' approval)
  • Local unit tests performed
  • Documentation exists link
  • Local pre-commit hooks performed
  • Desired commit message set as PR title and description set above
  • Link to relevant GitHub issue provided

Ja Young Lee added 2 commits June 28, 2023 11:16
- Swapped ModelType enums to str on examples
- Connected annex files to the existing files under prompts
- Connected a prompt example to the example file
- Swapped not supported model name

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <younglee@ibm.com>
- updated included line numbers on a prompt example

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <younglee@ibm.com>
@jayolee jayolee self-assigned this Jun 28, 2023
@coveralls
Copy link

coveralls commented Jun 28, 2023

Pull Request Test Coverage Report for Build 5414512284

  • 4 of 4 (100.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 94.659%

Totals Coverage Status
Change from base Build 5379768299: 0.0%
Covered Lines: 1223
Relevant Lines: 1292

💛 - Coveralls

@moneill0
Copy link
Contributor

Running examples/user/complete_my_code.py threw this error for me:

genai.exceptions.genai_exception.GenAiException: b'{"status_code":400,"error":"Bad Request","message":"Model has been removed","extensions":{"code":"INVALID_INPUT","state":{"model_id":"salesforce/codegen-16b-mono"}}}'

@moneill0
Copy link
Contributor

Running examples/user/complete_my_code.py threw this error for me:

genai.exceptions.genai_exception.GenAiException: b'{"status_code":400,"error":"Bad Request","message":"Model has been removed","extensions":{"code":"INVALID_INPUT","state":{"model_id":"salesforce/codegen-16b-mono"}}}'

Same error for https://github.com/IBM/ibm-generative-ai/pull/62/files

@jayolee
Copy link
Contributor Author

jayolee commented Jun 29, 2023

Running examples/user/complete_my_code.py threw this error for me:
genai.exceptions.genai_exception.GenAiException: b'{"status_code":400,"error":"Bad Request","message":"Model has been removed","extensions":{"code":"INVALID_INPUT","state":{"model_id":"salesforce/codegen-16b-mono"}}}'

Same error for https://github.com/IBM/ibm-generative-ai/pull/62/files

Thanks for testing!
This error only happens with a certain API endpoint. Will bring it up at standup.

…ated generate param info

- Swapped unavailable model on examples
- Updated undpoint section on Readme to have more information
- Updated Readme's API link to bold
- Swapped ModelType to string in Readme
- Updated parameter information of GenerateParams about invalid ones with greedy decoding

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <younglee@ibm.com>
Copy link
Member

@mirianfsilva mirianfsilva left a comment

Choose a reason for hiding this comment

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

lgtm!

@onkarbhardwaj onkarbhardwaj self-requested a review June 30, 2023 17:07
@vedem1192 vedem1192 merged commit 142a866 into IBM:develop Jun 30, 2023
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.

6 participants