[Good First Issue]: Replicate Existing Cookbooks and Create New Examples - Batch 6

[ijindal1]

trafficstars

For context, see: CONTRIBUTING.md and cookbooks/README.md

Overview

We're looking for contributors to help expand our collection of Jupyter notebooks (cookbooks) that demonstrate various AI and automation tasks using Julep's features. This is a great opportunity for newcomers to get familiar with Julep and contribute to the project!

Objectives

1. Replicate existing cookbooks to ensure they're up-to-date and functioning correctly.
2. Create new cookbooks based on the ideas listed in the cookbooks/README.md file.

Tasks

1. Replicating Existing Cookbooks

• Choose one or more of the existing cookbooks from the list in cookbooks/README.md.
• Follow the instructions in the notebook to run it in Google Colab.
• Verify that all cells execute without errors and produce the expected outputs.
• If you encounter any issues or outdated information, document them for updating.

2. Creating New Cookbooks

• Select an idea from the "Potential Cookbooks for Contributors" section in cookbooks/README.md.
• Create a new Jupyter notebook following the structure of existing cookbooks.
• Implement the chosen use case using Julep's features.
• Ensure your notebook includes:
  • A clear introduction and overview of the task
  • Step-by-step implementation with explanations
  • Proper error handling and user guidance
  • A conclusion summarizing the key learnings

Guidelines for Creating New Cookbooks

1. Naming Convention: Name your notebook following the pattern XX-Descriptive_Name.ipynb, where XX is the next available number in the sequence.

2. Structure:

   • Start with an introduction explaining the purpose of the cookbook.
   • Include a cell for installing the Julep client.
   • Create sections for each major step (e.g., Creating an Agent, Defining a Task, Creating an Execution).
   • Add markdown cells to explain concepts and code.

3. Code Quality:

   • Ensure your code is well-commented and follows PEP 8 style guidelines.
   • Use meaningful variable names.
   • Handle potential errors gracefully.

4. Documentation:

   • Explain each step clearly, assuming the reader is new to Julep.
   • Include links to relevant Julep documentation where appropriate.

5. Testing:

   • Test your notebook thoroughly in Google Colab to ensure it runs without errors.
   • Include sample outputs where relevant.

6. Update README.md:

   • Add your new cookbook to the table in cookbooks/README.md.
   • Include a brief description and mark it as implemented.

How to Contribute

1. Fork the repository.
2. Create a new branch for your cookbook (e.g., cookbook/weather-notification-service).
3. Develop your cookbook following the guidelines above.
4. Test your notebook thoroughly.
5. Commit your changes and push to your fork.
6. Open a pull request with a clear description of your contribution.

Resources

• Julep Documentation
• Existing Cookbooks
• CONTRIBUTING.md

Need Help?

If you have any questions or need assistance, please don't hesitate to ask in the comments of this issue or reach out on our Discord channel.

We're excited to see your contributions and help grow the Julep cookbook collection!

---

Long-ass list of ideas

41. Intelligent Content Optimization Workflow Description: Analyzes content performance, optimizes it for better engagement, and republishes optimized content. Features: Tools: web_search, huggingface Step Types: Tool Call, Evaluate, Conditional Logic, Optimize Content (Prompt), Publish Content, Log
42. Automated Legal Document Processing Description: Processes legal documents by extracting key information, checking for compliance, and storing them securely. Features: Tools: wikipedia, api_call Step Types: Tool Call, Evaluate, Conditional Logic, Extract Information (Prompt), Store Document (Set), Log
43. Intelligent Job Application Tracker Description: Tracks job applications, analyzes responses, and provides recommendations for improving applications. Features: Tools: sendgrid, slack, huggingface Step Types: Tool Call, Evaluate, Conditional Logic, Send Recommendations, Log
44. Automated Content Rescheduling System Description: Monitors content performance and reschedules underperforming content for better visibility. Features: Tools: api_call, sendgrid Step Types: Tool Call, Evaluate, Conditional Logic, Reschedule Content (Set), Send Notifications, Log
45. AI-Powered Personal Finance Advisor Description: Analyzes user financial data, provides budgeting advice, and suggests investment opportunities. Features: Tools: finance, sendgrid, huggingface Step Types: Tool Call, Evaluate, Conditional Logic, Generate Advice (Prompt), Send Recommendations, Log
46. Automated Code Deployment and Testing Description: Deploys code changes, runs automated tests, and rolls back if tests fail. Features: Tools: api_call, slack, sendgrid Step Types: Tool Call, Evaluate, Conditional Logic, Run Tests (Tool Call), Deploy Code, Send Notifications, Log
47. Intelligent Document Version Control Description: Manages document versions, tracks changes, and notifies users about updates. Features: Tools: wikipedia, slack Step Types: Tool Call, Evaluate, Conditional Logic, Update Version (Set), Send Notifications, Log
48. Automated Marketing Campaign Manager Description: Creates, schedules, and manages marketing campaigns, tracks performance, and optimizes strategies. Features: Tools: sendgrid, slack, finance Step Types: Tool Call, Evaluate, Conditional Logic, Schedule Campaign (Set), Track Performance, Log

[prathamesh424]

@ijindal1 can you assign this issue to me

[Mefisto04]

hey @ijindal1, I have a approach to solve this,

1. Replicate Cookbooks:

   • Pick a notebook from README.md, run it in Colab, verify outputs, and note issues.

2. Create New Cookbooks:

   • Choose a new idea, follow the structured format (intro, steps, code), use clear comments, and handle errors.

please assign me this issue so that i can start working on it

[ijindal1]

Which idea do you want to work on @Mefisto04 @prathamesh424 ? You can both pick an idea each and work on it. Please don't wait for me to assign the issue to you. Actually that's not needed.

[RoushniSinha]

@ijindal1 Can you assign this issue to me 41.Intelligent Content Optimization Workflow i really want to work ON .