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

added intent evaluator #56

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

vyelluru
Copy link

@vyelluru vyelluru commented May 14, 2024

Summary by CodeRabbit

  • New Features

    • Introduced intent evaluation functionality for natural language processing tasks.
    • Added concise system and user prompts for classifying questions based on intent.
  • Improvements

    • Enhanced handling of malicious keywords in model responses.
  • Usability

    • Improved evaluation results and metrics generation for better accuracy in intent classification.

Copy link
Contributor

coderabbitai bot commented May 14, 2024

Walkthrough

The recent updates introduce a new class Intent within the evaluator.py file, aimed at enhancing the evaluation of intent in natural language processing tasks. It includes methods for processing model responses, generating metrics, and handling prompts. Additionally, a new prompt.py file provides concise prompts for classifying questions based on intent.

Changes

Files Change Summaries
.../evaluator.py Introduced Intent class, added methods and properties for evaluation, metrics generation, and handling prompts.
.../prompt.py Added new concise system and user prompts for classifying questions as malicious or normal in intent.

In fields of code where bunnies hop,
New classes grow, evaluations don't stop.
With prompts so clear, intent so bright,
Our models now discern with might.
Metrics bloom, results in hand,
In the world of code, we understand.
🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 6

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 02290ca and a2aa11d.
Files selected for processing (2)
  • athina/evals/llm/intent/evaluator.py (1 hunks)
  • athina/evals/llm/intent/prompt.py (1 hunks)
Files skipped from review due to trivial changes (1)
  • athina/evals/llm/intent/prompt.py
Additional Context Used
Ruff (4)
athina/evals/llm/intent/evaluator.py (4)

2-2: typing.Tuple imported but unused


2-2: typing.Optional imported but unused


4-4: athina.interfaces.result.DatapointFieldAnnotation imported but unused


74-74: Local variable label is assigned to but never used

Additional comments not posted (7)
athina/evals/llm/intent/evaluator.py (7)

17-19: LGTM!


21-23: LGTM!


25-27: LGTM!


29-31: LGTM!


33-35: LGTM!


37-40: LGTM!


46-47: LGTM!

Comment on lines +12 to +15
def __init__(self, **kwargs):
self.model_name = "HUGGINGFACE_META_LLAMA_3_70B"
super().__init__(**kwargs, system_message_template=INTENT_EVAL_PROMPT_CONCISE_SYSTEM,
user_message_template=INTENT_EVAL_PROMPT_CONCISE_USER,)
Copy link
Contributor

Choose a reason for hiding this comment

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

Make the model name configurable.

- self.model_name = "HUGGINGFACE_META_LLAMA_3_70B"
+ self.model_name = kwargs.get("model_name", "HUGGINGFACE_META_LLAMA_3_70B")

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
def __init__(self, **kwargs):
self.model_name = "HUGGINGFACE_META_LLAMA_3_70B"
super().__init__(**kwargs, system_message_template=INTENT_EVAL_PROMPT_CONCISE_SYSTEM,
user_message_template=INTENT_EVAL_PROMPT_CONCISE_USER,)
def __init__(self, **kwargs):
self.model_name = kwargs.get("model_name", "HUGGINGFACE_META_LLAMA_3_70B")
super().__init__(**kwargs, system_message_template=INTENT_EVAL_PROMPT_CONCISE_SYSTEM,
user_message_template=INTENT_EVAL_PROMPT_CONCISE_USER,)

Comment on lines +42 to +44
@property
def examples(self):
pass
Copy link
Contributor

Choose a reason for hiding this comment

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

Mark the examples property as abstract or implement it.

- def examples(self):
-     pass
+ @property
+ def examples(self):
+     raise NotImplementedError("Subclasses should implement this method.")

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
@property
def examples(self):
pass
@property
def examples(self):
raise NotImplementedError("Subclasses should implement this method.")

@@ -0,0 +1,92 @@
import time
from typing import List, Tuple, Optional
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove unused imports.

- from typing import List, Tuple, Optional
+ from typing import List

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
from typing import List, Tuple, Optional
from typing import List

import time
from typing import List, Tuple, Optional

from athina.interfaces.result import EvalResult, EvalResultMetric, DatapointFieldAnnotation
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove unused imports.

- from athina.interfaces.result import EvalResult, EvalResultMetric, DatapointFieldAnnotation
+ from athina.interfaces.result import EvalResult, EvalResultMetric

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
from athina.interfaces.result import EvalResult, EvalResultMetric, DatapointFieldAnnotation
from athina.interfaces.result import EvalResult, EvalResultMetric

failure = self.is_failure(result)
passed_value = 1 - float(failure)
metrics.append(EvalResultMetric(id=MetricType.PASSED.value, value=passed_value))
label: str = self.label
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove unused variable label.

- label: str = self.label

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
label: str = self.label

Comment on lines +61 to +65
malicious_keywords = ["malicious", "illegal", "harm", "harmful", "unlawful", "hurt", "pain", "hate"]
for keyword in malicious_keywords:
if keyword.lower() in chat_completion_response_json["result"].lower():
self.label = "malicious"
self.label = "normal"
Copy link
Contributor

Choose a reason for hiding this comment

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

Fix the label assignment logic.

- for keyword in malicious_keywords:
-     if keyword.lower() in chat_completion_response_json["result"].lower():
-         self.label = "malicious"
- self.label = "normal"
+ self.label = "normal"
+ for keyword in malicious_keywords:
+     if keyword.lower() in chat_completion_response_json["result"].lower():
+         self.label = "malicious"
+         break

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
malicious_keywords = ["malicious", "illegal", "harm", "harmful", "unlawful", "hurt", "pain", "hate"]
for keyword in malicious_keywords:
if keyword.lower() in chat_completion_response_json["result"].lower():
self.label = "malicious"
self.label = "normal"
malicious_keywords = ["malicious", "illegal", "harm", "harmful", "unlawful", "hurt", "pain", "hate"]
self.label = "normal"
for keyword in malicious_keywords:
if keyword.lower() in chat_completion_response_json["result"].lower():
self.label = "malicious"
break

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.

None yet

1 participant