diff --git a/docs/src/roadmap.md b/docs/src/roadmap.md index e6f4e55..4e2e3ff 100644 --- a/docs/src/roadmap.md +++ b/docs/src/roadmap.md @@ -2,8 +2,6 @@ An unordered list of potential future features: -* Igni - A scale-out multi-tenant vidformer server in the cloud - * Supervision Integration * Full GPU Acceleration diff --git a/docs/src/tools.md b/docs/src/tools.md index ad4ad31..7a36c80 100644 --- a/docs/src/tools.md +++ b/docs/src/tools.md @@ -10,25 +10,22 @@ vidformer is a highly modular suite of tools that work together: - [*libvidformer*](./libvidformer.md): The core data-oriented declarative video editing library - An embedded video processing execution engine with low-level interfaces - Systems code, written in Rust 🦀 - - **You should use if:** You are building a VDBMS or other multimodal data-system infrastructure. + - **You should use if:** You are building a VDBMS or other multimodal data-system *infrastructure*. - **You should *not* use if:** You just want to use vidformer in your workflows or projects. -- *yrden*: A vidformer Video-on-Demand server - - Provides vidformer services over a REST-style API - - Allows for client libraries to be written in any language - - Serves video results via [HLS](https://en.wikipedia.org/wiki/HTTP_Live_Streaming) streams +- *yrden*: A vidformer server for local use - Designed for local single-tenant use - - **You should use if:** You want to create faster video results in your workflows or projects. - - Note that yrden servers may be spun up transparently by client libraries, so you might use yrden without realizing it. + - Enables broad drop-in `cv2` compatability + - Supports basic Video on Demand hosting -- *igni*: A *planned* scale-out Video-on-Demand server - - Will allow for scalable and secure public-facing VOD endpoints +- *igni*: A vidformer server for the cloud + - An *in progress* multi-tenant scale-out server + - Designed for Video on Demand *only* + - Does not support full-video exports + - All video sources must be over the network, not local + - Enables live streaming and waiting on external dependencies for even lower time-to-playback latency **Client libraries in other languages:** Writing a vidformer client library for other languages is simple. It's a few hundred lines of code, and you just have to construct some JSON. Contributions or suggestions for other languages are welcome. - -**Other VoD servers:** -We provide yrden as a simple reference VoD server implementation. -If you want to scale-out deployments, multi-tenant deployments, or deep integration with a specific system, writing another VoD server is needed. (In progress work) diff --git a/vidformer-igni/README.md b/vidformer-igni/README.md index ed74b66..9be528f 100644 --- a/vidformer-igni/README.md +++ b/vidformer-igni/README.md @@ -7,4 +7,4 @@ The next generation scale-out vidformer server. ```bash docker-compose -f docker-compose-db.yaml up cargo run -- server -``` \ No newline at end of file +```