Documentation

Welcome to the official documents for the Gorse recommender system.

Documentation Versions

Current version is master, we maintain the following versions of Gorse documentation:

• master
• 0.4

Table of Contents

• Quick Start
• Deploy
  • Binary Deployment
  • Docker Deployment
  • Kubernetes Deployment
• Configuration
• Concepts
  • Data Objects
  • Algorithms
  • How It Works
  • Evaluation
• API
  • RESTful API
  • Go SDK
  • Python SDK
  • TypeScript SDK
  • Java SDK
  • Rust SDK
  • PHP SDK
  • Ruby SDK
  • .NET SDK
• Gorse Dashboard
• Benchmark
• Contribution Guide
• FAQ

Contributing Guide

You can start from any one of the following items to help improve Gorse documents:

• Fix typos or format (punctuation, space, indentation, code block, etc.)
• Fix or update inappropriate or outdated descriptions
• Add missing content (sentence, paragraph, or a new document)
• Translate docs changes from English to Chinese