GitHub

Welcome to RxInferServer

Warning

The implementation is work in progress and the API is not yet stable and may undergo significant changes. Use at your own risk.

RxInferServer is a Julia package that provides an implementation of a REST API server for RxInfer.jl, enabling remote access to inference capabilities through HTTP endpoints. The server is built on top of HTTP.jl and follows OpenAPI specifications. Read more about the OpenAPI specification here.

Note

While the server is technically implemented as a Julia package, it relies on locally auto-generated code from the OpenAPI specification. This makes it more challenging (though not impossible) to use it as a direct dependency in another Julia project. For the same reason, the server is not registered as a Julia package and cannot be installed using Pkg.jl. Please refer to the Pkg.jl documentation for more information on working with such packages.

Getting started

  • See the Getting started section to learn how to use the server.
  • See the Configuration section to learn how to configure the server.
  • See the How to Add a Model manual to learn how to create and add your own models.
  • See the Developers guide section for more details on the development process and implementation details.
  • See the OpenAPI documentation section for more details on the OpenAPI specification and the generated server and client code.

Available SDKs

RxInferServer provides official SDKs for different programming languages:

  • Julia SDK: Included in this repository under the openapi/client folder. This SDK is automatically generated from the OpenAPI specification and is the most up-to-date implementation.
  • Python SDK: Available as a separate package at RxInferClient.py. This client provides a Python interface to interact with RxInferServer.

License

This project is licensed under the GNU Affero General Public License v3.0 - see the LICENSE in the repository for details. For companies and organizations that require different licensing terms, alternative licensing options are available from Lazy Dynamics. Please contact Lazy Dynamics for more information about licensing options that may better suit your specific needs and use cases.

Index