Skip to content

Commit

Permalink
chore: Update contributing and README documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nadeesha committed Nov 29, 2024
1 parent fed85c6 commit 7c7b6ce
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 53 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ We maintain different code style guidelines for each programming language in the
- Reference any relevant issues or PRs in the message

Example:

```
Fix: Resolve memory leak in function pre-processor (#123)
```
Expand All @@ -73,14 +74,13 @@ Fix: Resolve memory leak in function pre-processor (#123)
- Use Pull Requests for code contributions
- Be respectful and constructive in all communications
- Tag relevant maintainers when needed
- Seek help in the [Discord](https://go.inferable.ai/discord)

## Questions?

If you have questions about contributing, feel free to:

- Open an issue with your question
- Ask in the relevant Pull Request
- Contact the maintainers via [Discord](https://go.inferable.ai/discord)

## License

Expand Down
74 changes: 23 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,80 +4,52 @@

<div align="center">

[![Website](https://img.shields.io/badge/website-inferable.ai-blue)](https://inferable.ai) [![Documentation](https://img.shields.io/badge/docs-inferable.ai-brightgreen)](https://docs.inferable.ai/) [![Discord](https://img.shields.io/badge/community-Discord-blue)](https://go.inferable.ai/discord) [![Slack](https://img.shields.io/badge/enterprise-Slack-blue)](https://go.inferable.ai/slack)
[![Website](https://img.shields.io/badge/website-inferable.ai-blue)](https://inferable.ai) [![Documentation](https://img.shields.io/badge/docs-inferable.ai-brightgreen)](https://docs.inferable.ai/)

![NPM Version](https://img.shields.io/npm/v/inferable?color=32CD32) ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/inferablehq/inferable?filename=sdk-go%2Fgo.mod&color=32CD32) ![NuGet Version](https://img.shields.io/nuget/v/inferable?color=32CD32)

</div>

# Introduction
# The Problem

Inferable is a developer platform that makes it easy to build and deploy reliable, secure LLM-based applications.
Building reliable AI agents at scale is hard.

## Key Features
- 💽 **State management**: Unless we run everything in one process and in-memory, we need to manage distributed state.

🚀 **[2-Minute Setup](https://docs.inferable.ai/pages/quick-start)**: Get started in minutes with our [managed platform](https://app.inferable.ai) - wrap your existing functions, REST APIs and GraphQL endpoints as tools.
- ⛔️ **Fault tolerance**: Distributed tools mean we need to manage network failures, and coordinate between agents and tools running on different machines.

🤖 **[Managed Agent Runtime](https://docs.inferable.ai/pages/runs)**: Managed [ReAct](https://www.promptingguide.ai/techniques/react)-like agent runtime powered by your own functions.
- 🧑‍💻 **Human in the loop**: We don't want AI to be completely autonomous. We want to build abstractions that help humans intervene.

⚡️ **[Durable Tool Calling](https://docs.inferable.ai/pages/functions)**: Our durable execution engine helps you agents recover from tool-calling failures, load balance across your compute, and caches results for fast re-runs.
- 🔄 **Point-in-time consistency**: Even if we've got all of this working, distributed systems are inherently unreliable. And so are the agents running on them.

🛡️ **[Zero Network Config](https://docs.inferable.ai/pages/no-incoming-connections)**: No inbound connections or networking config required - your compute runs securely behind your firewall, and polls Inferable for instructions.
# The Solution

💻 **[Your Infrastructure](https://docs.inferable.ai/pages/on-premise)**: All functions run on your Infrastructure - Keep sensitive data and compute on-premise while leveraging our agent runtime. Inferable can't see or access any runtime information or environment variables.
- 🤖 **[Managed Agent Runtime](https://docs.inferable.ai/pages/runs)**: Managed [ReAct](https://www.promptingguide.ai/techniques/react)-like agent runtime powered by your own functions.

🔌 **Multiple Language Support**: Native SDKs for TypeScript, Go, .NET and more coming soon - integrate with your existing codebase in minutes.
- ⚡️ **[Durable Tool Calling](https://docs.inferable.ai/pages/functions)**: Durable execution engine helps agents recover from tool-calling failures, load balance across your compute, and caches results for fast re-runs.

## Get Started

### Inferable Cloud

Managed deployment of Inferable built for high availability and security. Inferable Cloud includes a [generous free teir](https://inferable.ai/pricing) and requires no credit card to get started.

[Inferable Cloud](https://app.inferable.ai).

### Open-source
- 🛡️ **[Zero Network Config](https://docs.inferable.ai/pages/no-incoming-connections)**: No inbound connections or networking config required. Everything works via long-polling pub-sub.

Inferable is 100% open-source and self-hostable.
- 🔌 **Multiple Language Support**: Native SDKs for TypeScript, Go, .NET and more coming soon - integrate with your existing codebase in minutes.

[Self hosting guide](https://docs.inferable.ai/pages/self-hosting)
-**Fully open-source and self-hostable**: Inferable is 100% open-source, MIT licensed, and self-hostable. We also offer a managed service with high availability and a generous free tier.

## SDKs

- [Node.js / TypeScript SDK](./sdk-node/README.md)
- [Go SDK](./sdk-go/README.md)
- [.NET SDK](./sdk-dotnet/README.md)
- [React SDK](./sdk-react/README.md)

Each SDK directory contains its own README with specific installation instructions, quick start guide, and usage examples.

### Quick Start

For language-specific quick start guides, please refer to the README in each SDK's directory:
## Get Started

- [Node.js / TypeScript Quick Start](./sdk-node/README.md#quick-start)
- [Go Quick Start](./sdk-go/README.md#quick-start)
- [.NET Quick Start](./sdk-dotnet/README.md#quick-start)
- [React Quick Start](./sdk-react/README.md#quick-start)
Check out our [quick start guide](https://docs.inferable.ai/pages/quick-start) for a step-by-step guide on how to get started.

### SDK Feature Comparison
## Self hosting

### Core Features
Inferable is 100% open-source and self-hostable:

| Feature | Node.js | Go | .NET | React |
| --------------------------------------------------------------- | :-----: | :-: | :--: | :---: |
| Register [Functions](https://docs.inferable.ai/pages/functions) |||||
| Create [Runs](https://docs.inferable.ai/pages/runs) |||||
- [Self hosting guide](https://docs.inferable.ai/pages/self-hosting)

### Advanced Features
## Language support

| Feature | Node.js | Go | .NET |
| ------------------------------------------------------------------------------------------------------ | :-----: | :-: | :--: |
| [Cached](https://docs.inferable.ai/pages/functions#config-cache) results ||||
| Call [Timeouts](https://docs.inferable.ai/pages/functions#config-timeoutseconds) ||||
| Call [Retries](https://docs.inferable.ai/pages/functions#config-retrycountonstall) ||||
| Call [Approval](https://docs.inferable.ai/pages/functions#approvalrequest) (Human in the loop) ||||
| [Auth / Run Context](https://docs.inferable.ai/pages/runs#context) ||||
- [Node.js / TypeScript](./sdk-node/README.md) ([Quick start](./sdk-node/README.md#quick-start))
- [Go](./sdk-go/README.md) ([Quick start](./sdk-go/README.md#quick-start))
- [.NET](./sdk-dotnet/README.md) ([Quick start](./sdk-dotnet/README.md#quick-start))
- [React](./sdk-react/README.md) ([Quick start](./sdk-react/README.md#quick-start))

## Documentation

Expand Down

0 comments on commit 7c7b6ce

Please sign in to comment.