apunkt/plano
1
0
Fork 0
mirror of https://github.com/katanemo/plano.git synced 2026-04-25 00:36:34 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

minor fixes to README (#156)

Browse source 
Co-authored-by: Salman Paracha <salmanparacha@MacBook-Pro-261.local>
This commit is contained in:
Salman Paracha 2024-10-09 10:12:36 -07:00 • committed by GitHub
parent 42d4a28e13
commit 498e7f9724
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 60 additions and 57 deletions
Download patch file Download diff file Expand all files Collapse all files

63
README.md
View file

@ -8,15 +8,14 @@ Arch is an intelligent [Layer 7](https://www.cloudflare.com/learning/ddos/what-i
Arch is built on (and by the core contributors of) the wildly popular and robust [Envoy Proxy](https://www.envoyproxy.io/) with the belief that:
*Prompts are nuanced and opaque user requests, which require the same capabilities as traditional HTTP requests including secure handling, intelligent routing, robust observability, and integration with backend (API) systems for personalization – all outside business logic.*
>Prompts are nuanced and opaque user requests, which require the same capabilities as traditional HTTP requests including secure handling, intelligent routing, robust observability, and integration with backend (API) systems for personalization – all outside business logic.*
**Core Features**:
- Built on [Envoy](https://envoyproxy.io): Arch runs alongside application servers build on top of Envoy's proven HTTP management and scalability features to handle ingress and egreess prompts and LLM traffic
- Engineered with purpose-built [(fast) LLMs](https://huggingface.co/collections/katanemo/arch-function-66f209a693ea8df14317ad68): Arch is optimized for sub-billion parameter LLMs to handle fast, cost-effective, and accurate prompt-based tasks like function/API calling.
- Built on [Envoy](https://envoyproxy.io): Arch runs alongside application servers, and builds on top of Envoy's proven HTTP management and scalability features to handle ingress and egreess traffic realted to prompts and LLMs
- Build fast Agentic and RAG applications. Engineered with purpose-built [(fast) LLMs](https://huggingface.co/collections/katanemo/arch-function-66f209a693ea8df14317ad68) to handle fast, cost-effective, and accurate prompt-based tasks like function/API calling.
- Prompt [Guardrails](https://huggingface.co/collections/katanemo/arch-guard-6702bdc08b889e4bce8f446d): Arch centralizes prompt guardrails to prevent jailbreak attempts and ensure safe user interactions without writing extra code.
- Traffic Management: Arch manages LLM calls, offering smart retries, automatic cutover, and resilient upstream connections for continuous availability.
- Open Observability: Arch uses the W3C Trace Context standard to enable complete request tracing across applications, ensuring compatibility with observability tools, and provides metrics to monitor latency, token usage, and error rates, helping optimize AI application performance.
- [Coming Soon] Intent-Markers: Arch helps developers detect when users shift their intent, improving response relevance, token cost, and speed.
**Jump to our [docs](https://docs.archgw.com)** to learn more about how you can use Arch to improve the speed, robustneess and personalization of your GenAI apps
@ -127,60 +126,10 @@ print("OpenAI Response:", response.choices[0].text.strip())
```
## Observability
## [Observability](https://docs.archgw.com/guides/observability/observability.html)
Arch is designed to support best-in class observability by supporting open standards. Please read our [docs](https://docs.archgw.com/guides/observability/observability.html) on observability for more details on tracing, metrics, and logs
## Contribution
We would love feedback on our [Roadmap](https://github.com/orgs/katanemo/projects/1) and we welcome contributions to **Arch**!
Whether you're fixing bugs, adding new features, improving documentation, or creating tutorials, your help is much appreciated.
## How to Contribute
### 1. Fork the Repository
Fork the repository to create your own version of **Arch**:
- Navigate to the [Arch GitHub repository](https://github.com/katanemo/arch).
- Click the "Fork" button in the upper right corner.
- This will create a copy of the repository under your GitHub account.
### 2. Clone Your Fork
Once you've forked the repository, clone it to your local machine:
```bash
$ git clone https://github.com/katanemo/arch.git
$ cd arch
```
### 3. Create a branch
Use a descriptive name for your branch (e.g., fix-bug-123, add-feature-x).
```bash
$ git checkout -b <your-branch-name>
```
### 4. Make Your changes
Make your changes in the relevant files. If you're adding new features or fixing bugs, please include tests where applicable.
### 5. Test your changes
```bash
cd arch
cargo test
```
### 6. Push changes, and create a Pull request
Go back to the original Arch repository, and you should see a "Compare & pull request" button. Click that to submit a Pull Request (PR). In your PR description, clearly explain the changes you made and why they are necessary.
We will review your pull request and provide feedback. Once approved, your contribution will be merged into the main repository!
Contribution Guidelines
Ensure that all existing tests pass.
Write clear commit messages.
Add tests for any new functionality.
Follow the existing coding style.
Update documentation as needed.
To get in touch with us, please join our [discord server](https://discord.gg/rbjqVbpa). We will be monitoring that actively and offering support there.
Please vist our [Contribution Guide](arch/CONTRIBUTING.md) for more details

54
arch/CONTRIBUTING.md Normal file
View file

@ -0,0 +1,54 @@
# Contribution
We would love feedback on our [Roadmap](https://github.com/orgs/katanemo/projects/1) and we welcome contributions to **Arch**!
Whether you're fixing bugs, adding new features, improving documentation, or creating tutorials, your help is much appreciated.
## How to Contribute
### 1. Fork the Repository
Fork the repository to create your own version of **Arch**:
- Navigate to the [Arch GitHub repository](https://github.com/katanemo/arch).
- Click the "Fork" button in the upper right corner.
- This will create a copy of the repository under your GitHub account.
### 2. Clone Your Fork
Once you've forked the repository, clone it to your local machine:
```bash
$ git clone https://github.com/katanemo/arch.git
$ cd arch
```
### 3. Create a branch
Use a descriptive name for your branch (e.g., fix-bug-123, add-feature-x).
```bash
$ git checkout -b <your-branch-name>
```
### 4. Make Your changes
Make your changes in the relevant files. If you're adding new features or fixing bugs, please include tests where applicable.
### 5. Test your changes
```bash
cd arch
cargo test
```
### 6. Push changes, and create a Pull request
Go back to the original Arch repository, and you should see a "Compare & pull request" button. Click that to submit a Pull Request (PR). In your PR description, clearly explain the changes you made and why they are necessary.
We will review your pull request and provide feedback. Once approved, your contribution will be merged into the main repository!
Contribution Guidelines
Ensure that all existing tests pass.
Write clear commit messages.
Add tests for any new functionality.
Follow the existing coding style.
Update documentation as needed.
To get in touch with us, please join our [discord server](https://discord.gg/rbjqVbpa). We will be monitoring that actively and offering support there.