julep-ai / julep

A new DSL and server for AI agents and multi-step tasks
https://julep.ai
Apache License 2.0
2.62k stars 911 forks source link

[Good First Issue]: Replicate Existing Cookbooks and Create New Examples - Batch 7 #563

Closed ijindal1 closed 2 weeks ago

ijindal1 commented 1 month ago

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

2. Creating New Cookbooks

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

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

  1. AI-Driven Competitive Analysis Workflow Description: Analyzes competitors by gathering data from various sources, comparing metrics, and generating analysis reports. Features: Tools: hacker_news, web_search, huggingface Step Types: Tool Call, Evaluate, Conditional Logic, Generate Report (Prompt), Send Analysis, Log
  2. Automated Health Monitoring and Alerting System Description: Monitors health metrics, detects anomalies, and sends alerts to users and healthcare providers. Features: Tools: slack, sendgrid Step Types: Tool Call, Evaluate, Conditional Logic, Send Alert, Log, Loop
  3. Intelligent Travel Itinerary Planner Description: Plans travel itineraries based on user preferences, weather conditions, and available attractions. Features: Tools: weather, wikipedia, google_calendar, dalle Step Types: Tool Call, Evaluate, Conditional Logic, Create Itinerary (Set), Generate Images (Tool Call), Send Itinerary, Log
  4. Automated Data Backup and Archiving System Description: Backs up data regularly, archives old data, and ensures data integrity. Features: Tools: api_call, slack, sendgrid Step Types: Schedule (Sleep), Tool Call, Evaluate, Conditional Logic, Archive Data (Set), Send Notifications, Log
  5. AI-Powered Personal Diary and Reflection Tool Description: Helps users maintain a personal diary, reflects on entries, and provides insights into their emotions and growth. Features: Tools: huggingface, sendgrid Step Types: Tool Call, Evaluate, Conditional Logic, Generate Insights (Prompt), Send Reflections, Log
  6. Automated Stock Portfolio Manager Description: Manages stock portfolios by tracking performance, rebalancing investments, and sending performance reports. Features: Tools: finance, sendgrid Step Types: Tool Call, Evaluate, Conditional Logic, Rebalance Portfolio (Set), Send Reports, Log
  7. Intelligent Language Tutor Description: Provides language learning exercises, tracks progress, and offers personalized feedback to learners. Features: Tools: huggingface, sendgrid Step Types: Tool Call, Evaluate, Conditional Logic, Generate Exercises (Prompt), Send Feedback, Log
  8. Automated Incident Reporting and Resolution Workflow Description: Collects incident reports, categorizes them, initiates resolution workflows, and tracks resolution status. Features: Tools: slack, api_call, sendgrid Step Types: Tool Call, Evaluate, Conditional Logic, Initiate Resolution (Set), Send Notifications, Log
PRIYANKjakharia commented 1 month ago

i can work on this

prathamesh424 commented 1 month ago

@ijindal1 can you assign this issue to me

sahilborse commented 3 weeks ago

/attempt #563 @ijindal1 please assign this issue to me