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

[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

25. Personal Finance Tracker and Advisor Description: Tracks user expenses, analyzes spending patterns, and provides financial advice based on data. Features: Tools: finance, sendgrid Step Types: Tool Call, Evaluate, Conditional Logic, Set Budgets (Set), Send Advice (Prompt), Log
26. Automated Content Publishing Workflow Description: Creates, schedules, and publishes content to various platforms, ensuring consistency and timely updates. Features: Tools: twitter, google_calendar, sendgrid Step Types: Tool Call, Evaluate, Conditional Logic, Schedule Posts (Set), Publish Content (Tool Call), Log
27. AI-Powered Personal Assistant Description: Manages personal tasks, schedules appointments, sends reminders, and interacts through chat. Features: Tools: google_calendar, slack, sendgrid, weather Step Types: Chat, Tool Call, Evaluate, Conditional Logic, Set Reminders (Set), Schedule (Sleep), Log
28. Automated Bug Tracking and Reporting System Description: Monitors repositories for new issues, categorizes them, assigns them to developers, and sends notifications. Features: Tools: slack, api_call, sendgrid Step Types: Tool Call, Evaluate, Conditional Logic, Assign Issues (Set), Send Notifications, Log
29. Multi-Stage Data Validation Pipeline Description: Validates incoming data through multiple stages, applying different validation rules and cleaning steps before final acceptance. Features: Tools: huggingface, wikipedia Step Types: Tool Call, Evaluate, Conditional Logic, Transform Data (Set), Log, Return
30. Intelligent Document Summarization and Archiving Description: Summarizes lengthy documents, categorizes them, and archives the summaries for easy retrieval. Features: Tools: wikipedia, dalle Step Types: Tool Call, Evaluate, Conditional Logic, Set, Log, Return
31. Real-Time Stock Market Analysis and Alerting Description: Analyzes real-time stock market data, identifies trends, and alerts users about significant changes. Features: Tools: finance, slack Step Types: Tool Call, Evaluate, Conditional Logic, Send Alert, Loop, Log
32. Automated Webinar Scheduling and Management Description: Schedules webinars based on participant availability, sends reminders, and manages follow-up communications. Features: Tools: google_calendar, sendgrid, slack Step Types: Tool Call, Evaluate, Conditional Logic, Create Event (Set), Send Reminders, Log