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

feat: Implement self-instruct and evolve-instruct synthetic data generation pipeline #720

Open
wants to merge 34 commits into
base: master
Choose a base branch
from

Conversation

andrei3131
Copy link
Collaborator

Description

Implementation of a generic pipeline for synthetic data generation designed to support multiple methods, starting with self-instruct (credits to https://github.com/yizhongw/self-instruct).

Motivation and Context

New project: synthetic data generation

  • I have raised an issue to propose this change (required for new features and bug fixes)

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds core functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)
  • Example (update in the folder of example)

Implemented Tasks

  • Subtask 1
  • Subtask 2
  • Subtask 3

Checklist

Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

  • I have read the CONTRIBUTION guide. (required)
  • My change requires a change to the documentation.
  • I have updated the tests accordingly. (required for a bug fix or a new feature)
  • I have updated the documentation accordingly.

Copy link

coderabbitai bot commented Jul 11, 2024

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

CodeRabbit Configuration 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

Choose a reason for hiding this comment

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

May be better to put the logic in a main() function and then run

if __name__ == "__main__":
    main()

in the end

implementations/synthetic_datagen/method_factory.py Outdated Show resolved Hide resolved
implementations/synthetic_datagen/method_factory.py Outdated Show resolved Hide resolved
Copy link

Choose a reason for hiding this comment

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

Add a way to pass in tasks rather than always using the whole seed_tasks file?

@Hither1 Hither1 requested a review from Wendong-Fan July 11, 2024 10:31
@Hither1 Hither1 requested a review from lightaime July 11, 2024 17:40
Copy link

@Hither1 Hither1 left a comment

Choose a reason for hiding this comment

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

Maybe we can move the self_instruct/utils folder one level up and make it common to (potentially) other generation methods

@Wendong-Fan Wendong-Fan changed the title Implement self-instruct synthetic data generation pipeline feat: Implement self-instruct synthetic data generation pipeline Jul 12, 2024
@Wendong-Fan Wendong-Fan marked this pull request as ready for review July 12, 2024 18:07
@Wendong-Fan Wendong-Fan added this to the Sprint 7 milestone Jul 12, 2024
@andrei3131 andrei3131 changed the title feat: Implement self-instruct synthetic data generation pipeline feat: Implement self-instruct and evolve-instru synthetic data generation pipeline Jul 15, 2024
@andrei3131 andrei3131 changed the title feat: Implement self-instruct and evolve-instru synthetic data generation pipeline feat: Implement self-instruct and evolve-instruct synthetic data generation pipeline Jul 15, 2024
"""

self.prompt_templates[Mutation.FRESH_START] = (
self.prompt_templates['base']
Copy link
Collaborator Author

@andrei3131 andrei3131 Jul 16, 2024

Choose a reason for hiding this comment

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

We could move the prompts to a separate file, similar to templates.py, in self-instruct

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We could break down the implementation into smaller methods for ease of readability


import os

if isinstance(self.seed_data, str) and os.path.exists(self.seed_data):
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

let's try to use more descriptive variable names

type=str,
default="implementations/data/seed_files/alpaca_data.json",
)
parser.add_argument("--column_names", nargs='+', default="instruction")
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Let's move this to the jupyter notebook camel_demo_instruct.ipynb

return ret


class GradioClientPipeline:
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Is this necessary?

return ret


class HFPipeline:
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Is this necessary?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

If these pipelines are needed let's try to integrate them by creating specific agent systems

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Synthetic data does not need to be inside the package. Best to download it from huggingface.

@Appointat Appointat self-requested a review July 22, 2024 16:33
@CaelumF CaelumF self-requested a review July 22, 2024 16:46
@WHALEEYE WHALEEYE closed this Jul 24, 2024
@WHALEEYE WHALEEYE deleted the synth_data_self_instruct branch July 24, 2024 23:55
@WHALEEYE WHALEEYE restored the synth_data_self_instruct branch July 25, 2024 00:02
@WHALEEYE WHALEEYE reopened this Jul 25, 2024
Union[ChatCompletion, Stream[ChatCompletionChunk]]:
`ChatCompletion` in the non-stream mode.
"""
print(messages)
Copy link
Collaborator

Choose a reason for hiding this comment

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

IMO, you can use logging info to instead print func

Comment on lines +525 to +532
if isinstance(choice.message, list):
# If choice.message is a list, handle accordingly
# It's a check to fit with Nemotron model integration.
content = "".join(
[msg.content for msg in choice.message if msg.content]
)
else:
content = choice.message.content or ""
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please help explain the reason why choice.message will be a list

Comment on lines 37 to 71
class NemotronRewardEvalAgent(BaseEvalAgentSystem):
def __init__(self) -> None:
self.nemotron = NvidiaModelV2(model_type=ModelType.NEMOTRON_4_REWARD)

def run_eval(
self, synthetic_datum: SyntheticDatum
) -> Optional[Dict[str, Any]]:
message = [
{
"role": "user",
"content": USER_PROMPT_TEMPLATE.format(
instruction=synthetic_datum.instruction,
input=synthetic_datum.input,
),
},
{
"role": "assistant",
"content": synthetic_datum.output,
},
]
response = self.nemotron.run(message)
print(response)
match = re.search(r"content='(.*?)'", str(response))
if not match:
logger.error("Failed to parse response from Nemotron. {response}")
return None

scores_str = match.group(1)
logger.info(f"Scores: {scores_str}")
scores = {
item.split(":")[0]: float(item.split(":")[1])
for item in scores_str.split(",")
}

return scores
Copy link
Collaborator

Choose a reason for hiding this comment

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

need code comments in here

camel/models/ollama_model.py Show resolved Hide resolved
Comment on lines +36 to +39
@dataclass
class SyntheticDatum:
instruction: str
input: str
Copy link
Member

Choose a reason for hiding this comment

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

we are moving from dataclass to pydantic BaseModel, maybe better to use pydantic BaseModel?

Copy link

Choose a reason for hiding this comment

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

Is there an example in camel of using pydantic BaseModel?

Copy link
Member

Choose a reason for hiding this comment

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

I feel it's not necessary to set this SingleAgent class, in this class the model type is hard coded as ollama, why not calling agent from ChatAgent from camel.agents?

Copy link

Choose a reason for hiding this comment

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

Returns:
str: The response generated by the agent.
"""
for agent in self.agents:
Copy link
Member

Choose a reason for hiding this comment

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

how could it work? no self.agents

Copy link

Choose a reason for hiding this comment

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

This is still in progress sorry

Copy link
Member

Choose a reason for hiding this comment

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

what's this MultiAgent class used for?

Copy link

Choose a reason for hiding this comment

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

to initialize a multi-agent system with chat/eval agents etc. inside

import re
from typing import Any, Dict, Optional

from camel.models import NvidiaModelV2
Copy link
Member

Choose a reason for hiding this comment

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

if only NvidiaModelV2 is used, we can remove other models like NvidiaModelV3

Comment on lines +59 to +64
match = re.search(r"content='(.*?)'", str(response))
if not match:
logger.error("Failed to parse response from Nemotron. {response}")
return None

scores_str = match.group(1)
Copy link
Member

Choose a reason for hiding this comment

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

we can get the score from response without using regex matching

Copy link

@Hither1 Hither1 Jul 25, 2024

Choose a reason for hiding this comment

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

But in that way, it will give the error that we were discussing during the call

Comment on lines +25 to +28
raise NotImplementedError(
"This method must be implemented by subclasses."
)

Copy link
Member

Choose a reason for hiding this comment

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

normally we use pass rather than rasing error

Comment on lines +26 to +28
@property
def is_self_instruct(self) -> bool:
return self is SyntheticDataGeneratorMethodType.SELFINSTRUCT
Copy link
Member

Choose a reason for hiding this comment

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

why we need to check this? I think we can do the check by using .value

Copy link

Choose a reason for hiding this comment

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Reviewing
Development

Successfully merging this pull request may close these issues.

5 participants