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

Fix docstrings #3449

Merged
merged 10 commits into from
Jun 25, 2024
Merged

Fix docstrings #3449

merged 10 commits into from
Jun 25, 2024

Conversation

nick863
Copy link
Contributor

@nick863 nick863 commented Jun 21, 2024

Description

Fix the problem with not showing docstrings for the evaluators. https://microsoft.github.io/promptflow/reference/python-library-reference/promptflow-evals/promptflow.evals.evaluators.html. See work item 3305596.

All Promptflow Contribution checklist:

  • The pull request does not introduce [breaking changes].
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.
  • Create an issue and link to the pull request to get dedicated review from promptflow team. Learn more: suggested workflow.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

@nick863 nick863 requested a review from a team as a code owner June 21, 2024 00:06
Copy link

github-actions bot commented Jun 21, 2024

promptflow-evals test result

  9 files   -   3    9 suites   - 3   2h 29m 43s ⏱️ + 2h 9m 21s
 53 tests  -  29   46 ✅  -  36   7 💤 + 7  0 ❌ ±0 
477 runs   - 507  414 ✅  - 570  63 💤 +63  0 ❌ ±0 

Results for commit 4322a05. ± Comparison against base commit 756130c.

This pull request removes 82 and adds 53 tests. Note that renamed tests count towards both.
tests.evals.unittests.test_batch_run_context.TestBatchRunContext ‑ test_with_codeclient
tests.evals.unittests.test_batch_run_context.TestBatchRunContext ‑ test_with_pfclient
tests.evals.unittests.test_built_in_evaluator.TestBuiltInEvaluators ‑ test_fluency_evaluator
tests.evals.unittests.test_built_in_evaluator.TestBuiltInEvaluators ‑ test_fluency_evaluator_empty_string
tests.evals.unittests.test_built_in_evaluator.TestBuiltInEvaluators ‑ test_fluency_evaluator_non_string_inputs
tests.evals.unittests.test_chat_evaluator.TestChatEvaluator ‑ test_conversation_validation_invalid_citations
tests.evals.unittests.test_chat_evaluator.TestChatEvaluator ‑ test_conversation_validation_missing_role
tests.evals.unittests.test_chat_evaluator.TestChatEvaluator ‑ test_conversation_validation_normal
tests.evals.unittests.test_chat_evaluator.TestChatEvaluator ‑ test_conversation_validation_question_answer_not_paired
tests.evals.unittests.test_chat_evaluator.TestChatEvaluator ‑ test_per_turn_results_aggregation
…
tests.evals.e2etests.test_adv_simulator.TestAdvSimulator ‑ test_adv_conversation_sim_responds_with_responses
tests.evals.e2etests.test_adv_simulator.TestAdvSimulator ‑ test_adv_qa_sim_responds_with_one_response
tests.evals.e2etests.test_adv_simulator.TestAdvSimulator ‑ test_adv_sim_init_with_prod_url
tests.evals.e2etests.test_adv_simulator.TestAdvSimulator ‑ test_adv_summarization_jailbreak_sim_responds_with_responses
tests.evals.e2etests.test_adv_simulator.TestAdvSimulator ‑ test_adv_summarization_sim_responds_with_responses
tests.evals.e2etests.test_adv_simulator.TestAdvSimulator ‑ test_incorrect_scenario_raises_error
tests.evals.e2etests.test_builtin_evaluators.TestBuiltInEvaluators ‑ test_composite_evaluator_chat[False-True]
tests.evals.e2etests.test_builtin_evaluators.TestBuiltInEvaluators ‑ test_composite_evaluator_chat[True-True]
tests.evals.e2etests.test_builtin_evaluators.TestBuiltInEvaluators ‑ test_composite_evaluator_content_safety
tests.evals.e2etests.test_builtin_evaluators.TestBuiltInEvaluators ‑ test_composite_evaluator_content_safety_chat[False-False]
…

♻️ This comment has been updated with latest results.

@nick863 nick863 requested a review from a team as a code owner June 21, 2024 04:50
singankit
singankit previously approved these changes Jun 21, 2024
wangchao1230
wangchao1230 previously approved these changes Jun 21, 2024
@nick863 nick863 dismissed stale reviews from wangchao1230 and singankit via 75f0878 June 21, 2024 18:27
ninghu
ninghu previously approved these changes Jun 21, 2024
singankit
singankit previously approved these changes Jun 22, 2024
Copy link
Contributor

@danielsc danielsc left a comment

Choose a reason for hiding this comment

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

Can we please make sure to show the output format for each of these evaluators, too?

luigiw
luigiw previously approved these changes Jun 23, 2024
@nick863 nick863 dismissed stale reviews from luigiw, singankit, and ninghu via aa0d9e3 June 24, 2024 20:10
luigiw
luigiw previously approved these changes Jun 24, 2024
singankit
singankit previously approved these changes Jun 24, 2024
@nick863 nick863 dismissed stale reviews from singankit and luigiw via 4322a05 June 24, 2024 21:09
@nick863 nick863 requested review from singankit and luigiw June 24, 2024 21:10
@nick863 nick863 merged commit 2eb9cb4 into main Jun 25, 2024
37 checks passed
@nick863 nick863 deleted the nirovins/fix_docstrings branch June 25, 2024 04:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants