From d6a45630b543b28ab8e968d3d743ed033bbccb05 Mon Sep 17 00:00:00 2001 From: Nadeesha Cabral Date: Sun, 27 Oct 2024 23:10:25 +1100 Subject: [PATCH] chore: Enhance README with badges and feature details --- README.md | 56 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 45 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index aed249c1..21194d74 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,39 @@

- +

-# Inferable AI SDKs +[![Documentation](https://img.shields.io/badge/docs-inferable.ai-brightgreen)](https://docs.inferable.ai/) [![Discord](https://img.shields.io/badge/community-Discord-blue)](https://discord.gg/inferable) [![Website](https://img.shields.io/badge/website-inferable.ai-blue)](https://inferable.ai) +![NPM Version](https://img.shields.io/npm/v/inferable) ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/inferablehq/inferable?filename=sdk-go%2Fgo.mod) ![NuGet Version](https://img.shields.io/nuget/v/inferable) -[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) -[![Documentation](https://img.shields.io/badge/docs-inferable.ai-brightgreen)](https://docs.inferable.ai/) +# Introduction -This is the official monorepo for Inferable AI open-source components, supporting multiple programming languages. +Inferable is the developer platform for building agentic automations from your existing code. You bring the code, we bring the automation engine. -## Available SDKs +## Key Features + +### ✨ Developer Experience + +- Create and manage automations programmatically with a delightful developer experience. +- Get started quickly with native SDKs for TypeScript, Go, and .NET, with more languages coming soon. +- Integrate seamlessly with your existing codebases and APIs. No rewrites required. + +### 🤖 Managed Inference + +- We handle the complexities of model routing, reasoning, and tool usage for you. +- Declaratively define complex multi-step workflows. You give us the objective, we handle the rest. +- Monitor everything in real-time with comprehensive tracing, logging, and analytics. + +### 📈 Distributed Durable Execution + +- We handle service discovery and load balancing for your functions. +- Our durable execution engine helps you recover from partial failures, and caches results for fast re-runs. + +### 🔒 Security + +- Keep your data secure and private - all compute runs within your infrastructure with no inbound connections required. +- Protect sensitive data with end-to-end encryption and masking capabilities built right in. + +## SDKs - [Node.js / TypeScript SDK](./sdk-node/README.md) [![npm version](https://badge.fury.io/js/inferable.svg)](https://badge.fury.io/js/inferable) [![Downloads](https://img.shields.io/npm/dm/inferable)](https://www.npmjs.com/package/inferable) - [Go SDK](./sdk-go/README.md) @@ -27,11 +51,21 @@ For language-specific quick start guides, please refer to the README in each SDK ## Feature Comparison -| SDK | Register [Functions](https://docs.inferable.ai/pages/functions) | Create [Runs](https://docs.inferable.ai/pages/runs) | Create [Templates](https://docs.inferable.ai/pages/runs#prompt-templates) | Create [Blobs](https://docs.inferable.ai/pages/functions#blob) | -| --- | --- | --- | --- | --- | -| Node.js / TypeScript | ✅ | ✅ | ✅ | ✅ | -| Go | ✅ | ✅ | ❌ | ❌ | -| .NET | ✅ | ❌ | ❌ | ❌ | +### Core Features + +| Feature | Node.js | Go | .NET | +| --------------------------------------------------------------- | :-----: | :-: | :--: | +| Register [Functions](https://docs.inferable.ai/pages/functions) | ✅ | ✅ | ✅ | +| Create [Runs](https://docs.inferable.ai/pages/runs) | ✅ | ✅ | ❌ | + +### Advanced Features + +| Feature | Node.js | Go | .NET | +| --------------------------------------------------------------------- | :-----: | :-: | :--: | +| Create [Blob](https://docs.inferable.ai/pages/functions#blob) results | ✅ | ❌ | ❌ | +| [Mask](https://docs.inferable.ai/pages/functions#masked) results | ✅ | ❌ | ❌ | +| Visibility timeout configuration | ✅ | ❌ | ❌ | +| Retry configuration | ✅ | ❌ | ❌ | ## Documentation