Skip to content

Commit 0c60b4d

Browse files
authored
Update README.md
- Added a note about interactive examples folder - Moved Python integration down in the README and added a note about licensing
1 parent 1100b5e commit 0c60b4d

File tree

1 file changed

+25
-19
lines changed

1 file changed

+25
-19
lines changed

README.md

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,6 @@
77
[![Contribute a new example](https://img.shields.io/badge/Contribute-%20a%20new%20example-red)](https://examples.rxinfer.com/how_to_contribute/)
88
[![Q&A](https://img.shields.io/badge/Q&A-RxInfer-orange)](https://github.com/reactivebayes/RxInfer.jl/discussions)
99

10-
## Python Integration
11-
12-
RxInfer can be used from Python through our client-server infrastructure:
13-
14-
- **[RxInferServer.jl](https://github.com/lazydynamics/RxInferServer)** - A RESTful API service for deploying RxInfer models
15-
- **[RxInferClient.py](https://github.com/lazydynamics/RxInferClient.py)** - Python SDK for interacting with RxInferServer
16-
17-
The server provides OpenAPI-compliant endpoints for model deployment and inference, while the Python client offers a convenient interface to:
18-
- Create and manage model instances
19-
- Execute inference tasks
20-
- Monitor inference progress
21-
- Handle authentication and API keys
22-
- Process results in a native format
23-
24-
For more information, visit:
25-
- [Server Documentation](https://server.rxinfer.com)
26-
- [Python SDK Documentation](https://lazydynamics.github.io/RxInferClient.py/)
27-
2810
This repository contains a collection of examples for [RxInfer.jl](https://github.com/ReactiveBayes/RxInfer.jl), a Julia package for reactive message passing and probabilistic programming.
2911

3012
Navigate to the [Examples](https://examples.rxinfer.com) page to check the pre-rendered examples or clone the repository and run the examples locally. Additionally, explore the official [RxInfer.jl](https://docs.rxinfer.com) documentation.
@@ -60,6 +42,10 @@ Navigate to the [Examples](https://examples.rxinfer.com) page to check the pre-r
6042
6143
All the examples are Jupyter notebooks, which also can be run with [Jupyter](https://jupyter.org/).
6244

45+
## Interactive examples
46+
47+
Most of the examples are available on the [official website](https://examples.rxinfer.com). Some examples, however, cannot be converted to a static HTML file and thus are placed under `interactive/` folder. Those examples can only be executed inside Jupyter notebook environment (or a plugin like in VSCode) as they may require some features that are not available in pure HTML.
48+
6349
## Contributing
6450

6551
We welcome contributions! Please check our [contribution guide](https://examples.rxinfer.com/how_to_contribute/) for guidelines.
@@ -71,6 +57,26 @@ We welcome contributions! Please check our [contribution guide](https://examples
7157
- [RxInfer.jl Repository](https://github.com/ReactiveBayes/RxInfer.jl)
7258
- [Examples Documentation](https://examples.rxinfer.com)
7359

60+
## Python Integration
61+
62+
RxInfer can be used from Python through client-server infrastructure developed by Lazy Dynamics.
63+
64+
- **[RxInferServer.jl](https://github.com/lazydynamics/RxInferServer)** - A RESTful API service for deploying RxInfer models
65+
- **[RxInferClient.py](https://github.com/lazydynamics/RxInferClient.py)** - Python SDK for interacting with RxInferServer
66+
67+
**Note** that the license for the `RxInferServer` is different from Rxinfer and is hosted under a different organization.
68+
69+
The server provides OpenAPI-compliant endpoints for model deployment and inference, while the Python client offers a convenient interface to:
70+
- Create and manage model instances
71+
- Execute inference tasks
72+
- Monitor inference progress
73+
- Handle authentication and API keys
74+
- Process results in a native format
75+
76+
For more information, visit:
77+
- [Server Documentation](https://server.rxinfer.com)
78+
- [Python SDK Documentation](https://lazydynamics.github.io/RxInferClient.py/)
79+
7480
## License
7581

76-
This repository is licensed under the MIT License. See [LICENSE](LICENSE) for details.
82+
This repository is licensed under the MIT License. See [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)