saikanov commited on
Commit
6b22924
1 Parent(s): fc12014

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +60 -60
README.md CHANGED
@@ -1,60 +1,60 @@
1
- ---
2
- title: tech_news_agents
3
- app_file: src\tech_news\app.py
4
- sdk: gradio
5
- sdk_version: 5.4.0
6
- ---
7
- # TechNews Crew
8
-
9
- Welcome to the TechNews Crew project, powered by [crewAI](https://crewai.com). This template is designed to help you set up a multi-agent AI system with ease, leveraging the powerful and flexible framework provided by crewAI. Our goal is to enable your agents to collaborate effectively on complex tasks, maximizing their collective intelligence and capabilities.
10
-
11
- ## Installation
12
-
13
- Ensure you have Python >=3.10 <=3.13 installed on your system. This project uses [UV](https://docs.astral.sh/uv/) for dependency management and package handling, offering a seamless setup and execution experience.
14
-
15
- First, if you haven't already, install uv:
16
-
17
- ```bash
18
- pip install uv
19
- ```
20
-
21
- Next, navigate to your project directory and install the dependencies:
22
-
23
- (Optional) Lock the dependencies and install them by using the CLI command:
24
- ```bash
25
- crewai install
26
- ```
27
- ### Customizing
28
-
29
- **Add your `OPENAI_API_KEY` into the `.env` file**
30
-
31
- - Modify `src/tech_news/config/agents.yaml` to define your agents
32
- - Modify `src/tech_news/config/tasks.yaml` to define your tasks
33
- - Modify `src/tech_news/crew.py` to add your own logic, tools and specific args
34
- - Modify `src/tech_news/main.py` to add custom inputs for your agents and tasks
35
-
36
- ## Running the Project
37
-
38
- To kickstart your crew of AI agents and begin task execution, run this from the root folder of your project:
39
-
40
- ```bash
41
- $ crewai run
42
- ```
43
-
44
- This command initializes the tech_news Crew, assembling the agents and assigning them tasks as defined in your configuration.
45
-
46
- This example, unmodified, will run the create a `report.md` file with the output of a research on LLMs in the root folder.
47
-
48
- ## Understanding Your Crew
49
-
50
- The tech_news Crew is composed of multiple AI agents, each with unique roles, goals, and tools. These agents collaborate on a series of tasks, defined in `config/tasks.yaml`, leveraging their collective skills to achieve complex objectives. The `config/agents.yaml` file outlines the capabilities and configurations of each agent in your crew.
51
-
52
- ## Support
53
-
54
- For support, questions, or feedback regarding the TechNews Crew or crewAI.
55
- - Visit our [documentation](https://docs.crewai.com)
56
- - Reach out to us through our [GitHub repository](https://github.com/joaomdmoura/crewai)
57
- - [Join our Discord](https://discord.com/invite/X4JWnZnxPb)
58
- - [Chat with our docs](https://chatg.pt/DWjSBZn)
59
-
60
- Let's create wonders together with the power and simplicity of crewAI.
 
1
+ ---
2
+ title: tech_news_agents
3
+ app_file: src/tech_news/app.py
4
+ sdk: gradio
5
+ sdk_version: 5.4.0
6
+ ---
7
+ # TechNews Crew
8
+
9
+ Welcome to the TechNews Crew project, powered by [crewAI](https://crewai.com). This template is designed to help you set up a multi-agent AI system with ease, leveraging the powerful and flexible framework provided by crewAI. Our goal is to enable your agents to collaborate effectively on complex tasks, maximizing their collective intelligence and capabilities.
10
+
11
+ ## Installation
12
+
13
+ Ensure you have Python >=3.10 <=3.13 installed on your system. This project uses [UV](https://docs.astral.sh/uv/) for dependency management and package handling, offering a seamless setup and execution experience.
14
+
15
+ First, if you haven't already, install uv:
16
+
17
+ ```bash
18
+ pip install uv
19
+ ```
20
+
21
+ Next, navigate to your project directory and install the dependencies:
22
+
23
+ (Optional) Lock the dependencies and install them by using the CLI command:
24
+ ```bash
25
+ crewai install
26
+ ```
27
+ ### Customizing
28
+
29
+ **Add your `OPENAI_API_KEY` into the `.env` file**
30
+
31
+ - Modify `src/tech_news/config/agents.yaml` to define your agents
32
+ - Modify `src/tech_news/config/tasks.yaml` to define your tasks
33
+ - Modify `src/tech_news/crew.py` to add your own logic, tools and specific args
34
+ - Modify `src/tech_news/main.py` to add custom inputs for your agents and tasks
35
+
36
+ ## Running the Project
37
+
38
+ To kickstart your crew of AI agents and begin task execution, run this from the root folder of your project:
39
+
40
+ ```bash
41
+ $ crewai run
42
+ ```
43
+
44
+ This command initializes the tech_news Crew, assembling the agents and assigning them tasks as defined in your configuration.
45
+
46
+ This example, unmodified, will run the create a `report.md` file with the output of a research on LLMs in the root folder.
47
+
48
+ ## Understanding Your Crew
49
+
50
+ The tech_news Crew is composed of multiple AI agents, each with unique roles, goals, and tools. These agents collaborate on a series of tasks, defined in `config/tasks.yaml`, leveraging their collective skills to achieve complex objectives. The `config/agents.yaml` file outlines the capabilities and configurations of each agent in your crew.
51
+
52
+ ## Support
53
+
54
+ For support, questions, or feedback regarding the TechNews Crew or crewAI.
55
+ - Visit our [documentation](https://docs.crewai.com)
56
+ - Reach out to us through our [GitHub repository](https://github.com/joaomdmoura/crewai)
57
+ - [Join our Discord](https://discord.com/invite/X4JWnZnxPb)
58
+ - [Chat with our docs](https://chatg.pt/DWjSBZn)
59
+
60
+ Let's create wonders together with the power and simplicity of crewAI.