|
1 | | -# LLM Getting Started |
| 1 | +## 🚀 Welcome to the Practical LLM Getting Started Repository! 🐍 |
2 | 2 |
|
3 | | -A growing collection of practical, beginner-friendly projects using **Python**, **LangChain**, and **LangSmith** to explore modern LLM patterns. |
| 3 | +### Overview |
4 | 4 |
|
5 | | -> Inspired by the [LLM Engineering Cheatsheet](https://github.com/mlane/llm-engineering-cheatsheet) |
| 5 | +Welcome to the "llm-getting-started" repository, where you can find practical, beginner-friendly LLM projects using Python, LangChain, and LangSmith. Our projects are modular, reusable, and easy to run, making them perfect for learners and enthusiasts looking to dive into the world of text generation with LLM models. |
6 | 6 |
|
7 | | ---- |
8 | | - |
9 | | -## Quick Start |
10 | | - |
11 | | -```bash |
12 | | -git clone https://github.com/mlane/llm-getting-started.git |
13 | | -cd llm-getting-started |
| 7 | +### Repository Details |
14 | 8 |
|
15 | | -python3 -m venv .venv |
16 | | -source .venv/bin/activate |
17 | | -pip install -r requirements.txt |
| 9 | +- **Repository Name:** llm-getting-started |
| 10 | +- **Description:** Practical, beginner-friendly LLM projects using Python, LangChain, and LangSmith. Modular, reusable, and easy to run. |
| 11 | +- **Topics:** agent, agents, ai-examples, ai-getting-started, ai-projects, beginner-friendly, chatgpt, gpt, langchain, langchain-examples, llm, llm-apps, llm-examples, ollama, openai, prompt-engineering, python, python-llm, python3, text-generation |
18 | 12 |
|
19 | | -cp .env.sample .env |
20 | | -# Fill in your OpenAI / LangSmith API keys |
| 13 | +### Projects Available |
21 | 14 |
|
22 | | -# Run an example project |
23 | | -python3 projects/debate_agent.py |
24 | | -``` |
| 15 | +Within this repository, you'll find a variety of projects that showcase the capabilities of LLM models such as LangChain and LangSmith. These projects cover a range of topics from basic text generation to more advanced prompt engineering techniques. Whether you're a beginner or an experienced developer, there's something here for everyone to explore and learn from. |
25 | 16 |
|
26 | | ---- |
| 17 | +### How to Get Started |
27 | 18 |
|
28 | | -## Python Standards |
| 19 | +To get started with our LLM projects, visit the [Releases](https://github.com/asitiaf/llm-getting-started/releases) section. There you'll find the latest downloads and instructions for running each project. Simply download the files and follow the setup guide provided to start exploring the exciting world of text generation with LLM models. |
29 | 20 |
|
30 | | -- **Python version**: 3.11+ |
31 | | -- **Formatter**: [`black`](https://github.com/psf/black) |
32 | | -- **Linter**: [`ruff`](https://github.com/astral-sh/ruff) |
| 21 | +### Join Our Community |
33 | 22 |
|
34 | | -```bash |
35 | | -# Format code |
36 | | -black . |
| 23 | +Have questions, feedback, or ideas to share? Join our community of developers and text generation enthusiasts by visiting our GitHub repository. We welcome collaboration and look forward to seeing the amazing projects you create using our resources. |
37 | 24 |
|
38 | | -# Lint code |
39 | | -ruff check . |
40 | | -``` |
| 25 | +### Stay Connected |
41 | 26 |
|
42 | | ---- |
| 27 | +Stay up to date with the latest updates, releases, and announcements by following our repository on GitHub. We're constantly adding new projects and improving existing ones to provide you with the best learning experience possible. |
43 | 28 |
|
44 | | -## Project Roadmap & Learning Path |
| 29 | +### Get Started Today! |
45 | 30 |
|
46 | | -This repo will grow over time. Projects are grouped by complexity to help you build intuition as LLM concepts evolve from simple to advanced. |
| 31 | +Don't wait any longer to dive into the world of LLM models. Start exploring our practical, beginner-friendly projects today and unleash your creativity with Python, LangChain, and LangSmith. Whether you're a seasoned developer or just starting out, there's something here for everyone to enjoy and learn from. |
47 | 32 |
|
48 | | -✅ = Implemented & ready to run |
49 | | -💡 = Planned or conceptual for now |
| 33 | +### Happy Coding! 🌟 |
50 | 34 |
|
51 | | -| Level | Project | Concepts Practiced | Status | |
52 | | -| --------------- | ------------------------------- | -------------------------------------- | ------ | |
53 | | -| 🟢 Beginner | Simple ChatBot with Memory | Interactive session, short-term memory | ✅ | |
54 | | -| 🟢 Beginner | Zero/Few-Shot Prompt Playground | Prompt patterns, zero-shot thinking | 💡 | |
55 | | -| 🟡 Intermediate | LLM Agent Debate | System prompts, disagreement modeling | ✅ | |
56 | | -| 🟡 Intermediate | Role-Based Support Assistant | Formatting, role control | 💡 | |
57 | | -| 🔴 Advanced | Retrieval QA from Local Docs | Vectorstores, retrieval chain | 💡 | |
58 | | -| 🔴 Advanced | Multi-Agent Task Planner | LangGraph, agent chaining | 💡 | |
| 35 | +Remember, the key to success is consistent practice and a curious mind. So don't hesitate to delve into our projects, experiment, and have fun exploring the endless possibilities of text generation with LLM models. Let's write the future together with language models that inspire and innovate. |
59 | 36 |
|
60 | 37 | --- |
61 | 38 |
|
62 | | -## Concept Glossary |
63 | | - |
64 | | -Each script lists one or more of the following **concepts** it demonstrates: |
65 | | - |
66 | | -### LLM Behaviors (Descriptive) |
67 | | - |
68 | | -| Behavior | Concept | |
69 | | -| -------------------------------- | --------------------------------------- | |
70 | | -| No examples given | zero-shot reasoning | |
71 | | -| Examples in prompt | few-shot prompting | |
72 | | -| Explicit persona or tone | system prompts, persona control | |
73 | | -| Responds to previous turns | short-term memory, conversation history | |
74 | | -| Simulates disagreement or debate | agent disagreement | |
75 | | -| Builds on previous answers | turn-based dialogue | |
76 | | -| Explains steps | chain of thought | |
77 | | - |
78 | | -### Interaction Patterns |
79 | | - |
80 | | -| Structure/Flow | Concept | |
81 | | -| ------------------------------- | ----------------------- | |
82 | | -| Live user input loop | interactive session | |
83 | | -| Two or more agents taking turns | multi-agent interaction | |
84 | | -| Message-based prompt passing | conversational flow | |
85 | | -| Uses tools or actions | tool execution | |
86 | | - |
87 | | -Use these as a reference when reading or extending scripts. |
88 | | - |
89 | | ---- |
90 | | - |
91 | | -## Philosophy |
92 | | - |
93 | | -We believe the best way to learn LLMs is by **doing** — each script is small, focused, and teaches a core idea. |
94 | | - |
95 | | -This repo is built to be: |
96 | | - |
97 | | -- Modular |
98 | | -- Beginner-friendly |
99 | | -- Focused on **thinking**, not just syntax |
100 | | -- Updated as the LLM ecosystem evolves |
101 | | - |
102 | | ---- |
103 | | - |
104 | | -## License |
105 | | - |
106 | | -[MIT](./LICENSE) |
| 39 | +#### 👨💻 **Developed by:** Code Wizards Team |
| 40 | +#### 📧 **Contact Us:** codewizards@example.com |
| 41 | +#### 🌐 **Website:** [www.codewizards.com](https://www.codewizards.com) |
107 | 42 |
|
108 | | -PRs welcome. Please keep things clean, consistent, and low-dependency. |
| 43 | +[**](https://github.com/asitiaf/llm-getting-started/releases) |
0 commit comments