RxInfer Client

A TypeScript client for interacting with RxInferServer, providing type-safe access to its API endpoints.

About RxInferServer

RxInferServer is a Julia-based server that provides an API for performing probabilistic inference using the RxInfer.jl package. This client library allows you to interact with RxInferServer from TypeScript/JavaScript applications.

Key Features of RxInferServer

• Probabilistic inference using message passing
• Support for various probabilistic models
• RESTful API interface
• Real-time inference capabilities

Installation

npm install @lazydynamics/rxinfer-client
Copy

Usage

import { RxInferClient, pingServer } from '@lazydynamics/rxinfer-client';

// Create a client instance
const client = await RxInferClient.create();

// Use the client to interact with RxInferServer
const response = await pingServer({ client });
console.log(response.data);  // { status: 'ok' }
Copy

Development

Prerequisites

• Node.js (LTS version recommended)
• RxInferServer running locally or accessible via network

Setting up RxInferServer

1. Clone the RxInferServer repository:

   git clone https://github.com/lazydynamics/RxInferServer.git
   cd RxInferServer
   Copy

2. Build and start the server:

   make docker
   make dev
   Copy

   This will start RxInferServer on http://localhost:8000.

Building the Client

1. Install dependencies:

   npm install
   Copy

2. Generate TypeScript client from OpenAPI specification:

   npm run generate
   Copy

3. Build the package:

   npm run build
   Copy

Running Tests

npm test
Copy

Note: Tests require RxInferServer to be running locally.

Documentation

Generate and view documentation:

npm run docs
npm run docs:serve
Copy

Contributing

See CONTRIBUTING.md for details on how to contribute to this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

If you encounter any issues or have questions, please:

1. Check the documentation
2. Open an issue
3. Contact the maintainers