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.

Sign up for GitHub

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

Jump to bottom

Allow passing in required project_name #445

Merged
merged 5 commits into from
Feb 22, 2024
Merged

Allow passing in required project_name #445

merged 5 commits into from
Feb 22, 2024

Conversation

lbux
Copy link
Contributor

@lbux lbux commented Feb 20, 2024

UpTrain requires a project_name when using its API whereas openai does not. The integration will crash if no project_name is included.

This will allow for an eval declaration like so:

evaluator = UpTrainEvaluator(
metric=UpTrainMetric.METRIC,
api="uptrain",
project_name="uptrain-project",
)

This was the fix I found that resolved my issue. It might not be a full fix as I have not read too deep into the source code.

@lbux
Allow passing in required project_name
70c42a5 
UpTrain requires a project_name when using its API whereas openai does not. The integration will crash if no project_name is included.

This will allow for an eval declaration like so:

evaluator = UpTrainEvaluator(
    metric=UpTrainMetric.METRIC,
    api="uptrain",
    project_name="uptrain-project",
)
@lbux lbux requested a review from a team as a code owner February 20, 2024 05:44
@lbux lbux requested review from masci and removed request for a team February 20, 2024 05:44
@CLAassistant
Copy link

CLAassistant commented Feb 20, 2024 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the type:documentation Improvements or additions to documentation label Feb 21, 2024
masci
masci approved these changes Feb 22, 2024
View reviewed changes
Copy link
Contributor

@masci masci 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 the PR! Patch looks like a solid fix to me.

@masci
Copy link
Contributor

masci commented Feb 22, 2024

FTR https://docs.uptrain.ai/tutorials/uptrain-api-client#step-2-run-the-evaluation

@masci masci merged commit ffe86a9 into deepset-ai:main Feb 22, 2024
10 checks passed
shadeMe added a commit that referenced this pull request Feb 22, 2024
@shadeMe
Revert "Allow passing in required project_name (#445)"
0fa27a1 
This reverts commit ffe86a9.
shadeMe added a commit that referenced this pull request Feb 22, 2024
@shadeMe
fix: Revert "Allow passing in required project_name (#445)" (#467)
9996295 
* Revert "Allow passing in required project_name (#445)"

This reverts commit ffe86a9.

* fix: Fail early when API params are not correctly passed to the evaluator
doc: Update docstring to mention required API parameters

* Add back dependencies required for integration testing
@lbux lbux deleted the patch-1 branch February 22, 2024 21:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@masci masci masci approved these changes

Assignees
No one assigned
Labels
integration:uptrain type:documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@lbux @CLAassistant @masci