dlaima commited on
Commit
137679a
·
verified ·
1 Parent(s): 1b829e0

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +54 -1
README.md CHANGED
@@ -15,13 +15,51 @@ tags:
15
  - agent-course
16
  short_description: Personalized Greeting & Timezone Clock
17
  ---
18
- ## First Agent Template
 
 
19
 
20
  This application allows users to create personalized greeting messages and check the current local time in any global timezone.
21
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
22
  ### Features
23
  - Greeting Generator: Enter a name or phrase and choose how many times you'd like the greeting to be repeated. The app will generate a cheerful message like "Hello, HuggingFace!" multiple times.
24
  - Timezone Clock: Input a valid timezone (e.g., Europe/London, America/New_York), and the app will show the current local time for that region.
 
25
 
26
  ### Preview
27
 
@@ -30,6 +68,21 @@ This application allows users to create personalized greeting messages and check
30
 
31
 
32
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
33
 
34
 
35
 
 
15
  - agent-course
16
  short_description: Personalized Greeting & Timezone Clock
17
  ---
18
+
19
+
20
+ ## First Agent Template : Greet & Time
21
 
22
  This application allows users to create personalized greeting messages and check the current local time in any global timezone.
23
 
24
+
25
+ > 🧑‍🏫 This app is part of the **Hugging Face Courses** series and was developed as an educational project to showcase how machine learning
26
+ > can be used in real-world event scenarios.
27
+ > Learn more at [Hugging Face Courses](https://huggingface.co/learn).
28
+ ---
29
+
30
+ ### 🗂 Folder Structure
31
+
32
+ crewai-ollama-llama3/
33
+ ├── main.py # CrewAI agent setup
34
+ ├── ollama_llm.py # Custom Ollama wrapper using LangChain-compatible LLM
35
+ ├── requirements.txt # Dependencies
36
+
37
+ ### Repository Structure (🗂 Folder Structure)
38
+
39
+ ```
40
+ rt-agentic-ai-cert-week2/
41
+ ├── code/
42
+ │ ├── config/
43
+ │ │ ├── config.yaml # App config with reasoning strategies
44
+ │ │ └── prompt_config.yaml # Prompt configurations for examples
45
+ │ ├── lesson_1a_and_ab.py # Main script for lesson 1
46
+ │ ├── lesson_2.py # Main script for lesson 2
47
+ │ ├── paths.py # File path configurations
48
+ │ ├── prompt_builder.py # Modular prompt construction functions
49
+ │ └── utils.py # Utility functions
50
+ ├── data/
51
+ │ └── vae-publication.md # Sample publication for exercises
52
+ ├── outputs/ # Generated prompts and LLM responses
53
+ ├── .env.template # Environment variables template
54
+ ├── requirements.txt # Python dependencies
55
+ └── README.md
56
+ ```
57
+
58
+
59
  ### Features
60
  - Greeting Generator: Enter a name or phrase and choose how many times you'd like the greeting to be repeated. The app will generate a cheerful message like "Hello, HuggingFace!" multiple times.
61
  - Timezone Clock: Input a valid timezone (e.g., Europe/London, America/New_York), and the app will show the current local time for that region.
62
+ ---
63
 
64
  ### Preview
65
 
 
68
 
69
 
70
 
71
+ ---
72
+ ## 🤝 Contributing
73
+
74
+ We welcome contributions to improve GalaGuide!
75
+
76
+ 1. Fork the repository
77
+ 2. Create a new branch:
78
+ ```bash
79
+ git checkout -b feature-xyz
80
+
81
+
82
+
83
+
84
+
85
+
86
 
87
 
88