https://www.pipeless.ai/docs/_next/static/chunks/pages/v1/kvstore-92a2fd7bcf9bc09c.js

1(self.webpackChunk_N_E=self.webpackChunk_N_E||[]).push([[79],{578:function(e,t,n){(window.__NEXT_P=window.__NEXT_P||[]).push(["/v1/kvstore",function(){return n(5538)}])},9369:function(e,t,n){"use strict";var o=n(5893);n(7294);var i=n(5675),s=n.n(i),a=n(3750),r=n(1163),l=n(2681);let d={logo:(0,o.jsxs)("span",{style:{display:"flex",alignItems:"center"},children:[(0,o.jsx)(s(),{alt:"logo",width:30,height:30,src:"/docs/logo-400x400-rounded.png"}),"\xa0",(0,o.jsx)("b",{children:"Pipeless"})]}),logoLink:"https://pipeless.ai",primaryHue:297,project:{link:"https://github.com/pipeless-ai/pipeless"},chat:{link:"https://discord.gg/K2qxQ8uedG",icon:(0,o.jsx)(a.KpZ,{size:25})},docsRepositoryBase:"https://github.com/pipeless-ai/docs/tree/main",footer:{text:(0,o.jsx)("p",{children:"Copyright \xa9 2023 Pipeless, Inc."})},search:{loading:"Loading..."},head:()=>{let{asPath:e,defaultLocale:t,locale:n}=(0,r.useRouter)(),{frontMatter:i}=(0,l.ZR)(),s="https://www.pipeless.ai"+(t===n?e:"/".concat(n).concat(e));return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("meta",{property:"og:url",content:s}),(0,o.jsx)("meta",{property:"og:title",content:i.title||"Pipeless Documentation"}),(0,o.jsx)("meta",{property:"og:description",content:i.description||"Documentation about Pipeless, the computer vision framework"}),(0,o.jsx)("meta",{property:"og:image",content:"https://www.pipeless.ai/docs/logo-400x400-rounded.png"})]})},useNextSeoProps:()=>({titleTemplate:"%s – Pipeless"}),banner:{dismissible:!1,key:"agents",text:(0,o.jsx)("a",{target:"blank",href:"https://agents.pipeless.ai",children:(0,o.jsxs)("p",{children:["\uD83D\uDE80 \xa0\xa0",(0,o.jsx)("b",{children:"Pipeless Agents is live!"}),"\xa0Create vision powered apps and automations effortlessly within seconds.\xa0",(0,o.jsx)("span",{style:{textDecoration:"underline"},children:"Click here to get started!"})]})})},sidebar:{defaultMenuCollapseLevel:1}};t.Z=d},5538:function(e,t,n){"use strict";n.r(t),n.d(t,{__toc:function(){return d}});var o=n(5893),i=n(2673),s=n(2681),a=n(9369);n(9966);var r=n(2643),l=n(9013);let d=[{depth:2,value:"Setting and getting pairs from the KV store",id:"setting-and-getting-pairs-from-the-kv-store"},{depth:3,value:"Setting a pair",id:"setting-a-pair"},{depth:3,value:"Getting a pair",id:"getting-a-pair"}];function c(e){let t=Object.assign({h1:"h1",p:"p",h2:"h2",h3:"h3",code:"code",pre:"pre",span:"span",a:"a",strong:"strong"},(0,r.a)(),e.components);return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h1,{children:"Key-Value Store usage"}),"\n",(0,o.jsx)(t.p,{children:"Pipeless contains a key-value store that helps you in the cases when you need to share data\nbetween the execution of different frames or between the execution of different hooks within a stage."}),"\n",(0,o.jsx)(l.UW,{children:(0,o.jsx)(t.p,{children:"Note that stages are independent, so a stage cannot access the KV pairs set by a different stage."})}),"\n",(0,o.jsx)(t.h2,{id:"setting-and-getting-pairs-from-the-kv-store",children:"Setting and getting pairs from the KV store"}),"\n",(0,o.jsx)(t.p,{children:"To interact with the KV store you can use some functions that are embedded into your code and\nready to use, so you don't even need to import them."}),"\n",(0,o.jsx)(t.h3,{id:"setting-a-pair",children:"Setting a pair"}),"\n",(0,o.jsxs)(t.p,{children:["To set a new pair you can call the function ",(0,o.jsx)(t.code,{children:"pipeless_kvs_set"})," providing the key and the value:"]}),"\n",(0,o.jsx)(t.pre,{"data-language":"python","data-theme":"default",hasCopyCode:!0,children:(0,o.jsx)(t.code,{"data-language":"python","data-theme":"default",children:(0,o.jsxs)(t.span,{className:"line",children:[(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-function)"},children:"pipeless_kvs_set"}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-punctuation)"},children:"("}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-string-expression)"},children:'"my_key"'}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-punctuation)"},children:", "}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-string-expression)"},children:'"My value"'}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-punctuation)"},children:")"})]})})}),"\n",(0,o.jsxs)(t.p,{children:["The set function converts any value into string before inserting it into the store. And the ",(0,o.jsx)(t.a,{href:"#getting-a-pair",children:"get function"})," returns always a string."]}),"\n",(0,o.jsx)(t.h3,{id:"getting-a-pair",children:"Getting a pair"}),"\n",(0,o.jsxs)(t.p,{children:["To get a pair from the store you can call the function ",(0,o.jsx)(t.code,{children:"pipeless_kvs_get"})," providing the key to fetch."]}),"\n",(0,o.jsxs)(t.p,{children:["Due to the parallelized nature of Pipeless, ",(0,o.jsx)(t.strong,{children:"you must always check the value obtained"})," from the get function.\nWhen the key requested has not been set it will return an empty string. This may happen when your code tries to get\ndata from a previous frame that is being processed at the same time."]}),"\n",(0,o.jsx)(t.pre,{"data-language":"python","data-theme":"default",hasCopyCode:!0,children:(0,o.jsxs)(t.code,{"data-language":"python","data-theme":"default",children:[(0,o.jsxs)(t.span,{className:"line",children:[(0,o.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:"value "}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-keyword)"},children:"="}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:" "}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-function)"},children:"pipeless_kvs_get"}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-punctuation)"},children:"("}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-string-expression)"}

1,children:'"my_key"'}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-punctuation)"},children:")"})]}),"\n",(0,o.jsxs)(t.span,{className:"line",children:[(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-keyword)"},children:"if"}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:" "}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-keyword)"},children:"not"}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:" value"}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-punctuation)"},children:":"})]}),"\n",(0,o.jsxs)(t.span,{className:"line",children:[(0,o.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:"   "}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-function)"},children:"printf"}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-punctuation)"},children:"("}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-string-expression)"},children:'"There is no key set"'}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-punctuation)"},children:")"})]}),"\n",(0,o.jsx)(t.span,{className:"line",children:(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-keyword)"},children:"else"})}),"\n",(0,o.jsxs)(t.span,{className:"line",children:[(0,o.jsx)(t.span,{style:{color:"var(--shiki-color-text)"},children:"   "}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-function)"},children:"printf"}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-punctuation)"},children:"("}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-keyword)"},children:"f"}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-string-expression)"},children:'"Obtained value: '}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-constant)"},children:"{"}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-punctuation)"},children:"value"}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-constant)"},children:"}"}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-string-expression)"},children:'"'}),(0,o.jsx)(t.span,{style:{color:"var(--shiki-token-punctuation)"},children:")"})]})]})})]})}let p={MDXContent:function(){let e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{},{wrapper:t}=Object.assign({},(0,r.a)(),e.components);return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(c,{...e})}):c(e)},pageOpts:{filePath:"pages/v1/kvstore.mdx",route:"/v1/kvstore",frontMatter:{title:"Key-Value Store usage",description:"Learn to how use the included key value store to communicate data between the processing of different frames and the execution of different hooks"},pageMap:[{kind:"Meta",data:{index:"Introduction",contributing:"Contributing","-- Versions":{type:"separator",title:"Versions"},v1:"v1.x.x",v0:"v0.x.x",about:{title:"Home",type:"page",href:"https://pipeless.ai"},contact:{title:"Contact ↗",type:"page",href:"https://lfkz9noht13.typeform.com/to/aeOqKGPt",newWindow:!0}}},{kind:"MdxPage",name:"contributing",route:"/contributing",frontMatter:{title:"Contributing Guidelines",description:"Contribute to the Pipeless open-source computer vision framework in GitHub"}},{kind:"MdxPage",name:"index",route:"/",frontMatter:{title:"Introduction",description:"Introduction to Pipeless, the open-source and production ready computer vision framework. Enjoy serverless development experience for embedded computer vision."}},{kind:"MdxPage",name:"v0",route:"/v0",frontMatter:{title:"Pipeless v0.x",description:"Documentation for Pipeless versions 0.x. The open-source computer vision framework"}},{kind:"Folder",name:"v1",route:"/v1",children:[{kind:"Meta",data:{"getting-started":"\uD83D\uDE80 Getting Started","rest-api":"Pipeless REST API",formats:"Stream Formats and Protocols",inference:"Inference Runtimes",kvstore:"Key Value Store",container:"\uD83D\uDC0B Container images",deployment:"Deploying your application",models:"Ready to Use CV Models",examples:"\uD83C\uDF1F Examples",benchmark:"Benchmark",changes:"Version Notable Changes",troubleshooting:"Troubleshooting","restart-policy":"Processing Restart Policy"}},{kind:"MdxPage",name:"benchmark",route:"/v1/benchmark",frontMatter:{title:"Benchmark",description:"A benchmark obtained by running the Pipeless computer vision framework on different devices to measure the overhead"}},{kind:"MdxPage",name:"changes",route:"/v1/changes",frontMatter:{title:"Notable version changes",description:"A list of important changes between Pipeless ver

1sions"}},{kind:"MdxPage",name:"container",route:"/v1/container",frontMatter:{title:"Container Images",description:"Learn to run and deploy Pipeless using container images. There are images available for CPU, and GPU (CUDA and TensorRT). The container images can also be used to easily deploy Pipeless to the cloud."}},{kind:"MdxPage",name:"deployment",route:"/v1/deployment",frontMatter:{title:"Deploying your pipeless application",description:"Learn how to deploy a Pipeless application to either an edge device or to the cloud. Pipeless ca run in distributed cloud servers as well as edge and IoT devices."}},{kind:"Folder",name:"examples",route:"/v1/examples",children:[{kind:"Meta",data:{wattermark:"Adding wattermarks",cats:"Detecting Cats on a Video","tf-pose":"Pose detection with TensorFlow",yolov8:"Object detection - YOLOv8 Python lib","onnx-candy":"ONXX Runtime - Candy filter","onnx-yolo":"ONNX Runtime - Object detection with YOLO","gaze-piano":"Play a piano with your eyes by looking to the notes"}},{kind:"MdxPage",name:"cats",route:"/v1/examples/cats",frontMatter:{title:"Cats recognition example",description:"A Pipeless example to recognize and detect cats in a video stream"}},{kind:"MdxPage",name:"gaze-piano",route:"/v1/examples/gaze-piano",frontMatter:{title:"Play a piano with your eyes - Gaze estimation",description:"A Pipeless example that allows you play a virtual piano with your eyes by looking to the note you want to play"}},{kind:"MdxPage",name:"onnx-candy",route:"/v1/examples/onnx-candy",frontMatter:{title:"Candy filter with ONNX runtime",description:"A Pipeless example using the ONNX Runtime to apply a candy filter to a video stream"}},{kind:"MdxPage",name:"onnx-yolo",route:"/v1/examples/onnx-yolo",frontMatter:{title:"Object detection with ONNX Runtime",description:"A Pipeless example that runs inference using the ONNX Runtime and YOLO to detect objects in a video stream"}},{kind:"MdxPage",name:"tf-pose",route:"/v1/examples/tf-pose",frontMatter:{title:"Pose estimation/detection with TensorFlow",description:"A Pipeless example that detects the pose with 17 keypoints in a video stream"}},{kind:"MdxPage",name:"wattermark",route:"/v1/examples/wattermark",frontMatter:{title:"Adding wattermarks to a video",description:"The most basic Pipeless example adding a wattermark to a video"}},{kind:"MdxPage",name:"yolov8",route:"/v1/examples/yolov8",frontMatter:{title:"Object detection with YOLOv8 and Ultralytics SDK",description:"A Pipeless example to detect objects in a video stream using YOLOv8 via the Ultralytics Python SDK"}}]},{kind:"MdxPage",name:"examples",route:"/v1/examples",frontMatter:{title:"Examples",description:"A list of fully functional examples to play around with the Pipeless computer vision framework."}},{kind:"MdxPage",name:"formats",route:"/v1/formats",frontMatter:{title:"Supported stream formats and protocols",description:"Learn the supported formats and protocols that can be used to provide video to your Pipeless application"}},{kind:"Folder",name:"getting-started",route:"/v1/getting-started",children:[{kind:"Meta",data:{installation:"\uD83D\uDEE0️ Installation","project-structure":"\uD83D\uDCC2 Project Structure"}},{kind:"MdxPage",name:"installation",route:"/v1/getting-started/installation",frontMatter:{title:"Installation guide",description:"Learn to install Pipeless, the computer vision framework"}},{kind:"MdxPage",name:"project-structure",route:"/v1/getting-started/project-structure",frontMatter:{title:"Project structure",description:"Learn how a Pipeless project is structured in the filesystem"}}]},{kind:"MdxPage",name:"getting-started",route:"/v1/getting-started",frontMatter:{title:"Getting started",description:"Get started with the Pipeless computer vision framework and enjoy the development experience of serverless frameworks for embedded computer vision."}},{kind:"MdxPage",name:"inference",route:"/v1/inference",frontMatter:{title:"Inference runtimes",description:"Learn to how to load a model into one of the embedded inference runtimes to perform your computer vision tasks in CPU, or GPUs. Use CUDA, TensorRT, OpenVINO, CoreML in any kind of GPU, including Nvidia GPUs."}},{kind:"MdxPage",name:"kvstore",route:"/v1/kvstore",frontMatter:{title:"Key-Value Store usage",description:"Learn to how use the included key value store to communicate data between the processing of different frames and the execution of different hooks"}},{kind:"Folder",name:"models",route:"/v1/models",children:[{kind:"Folder",name:"tensorflow",route:"/v1/models/tensorflow",children:[{kind:"MdxPage",name:"multi-pose-estimation",route:"/v1/models/tensorflow/multi-pose-estimation",frontMatter:{title:"Multi-pose estimation Tensorflow Model",description:"A ready to use TensorFlow model for multipose estimation in Python"}},{kind:"Meta",data:{"multi-pose-estimation":"Multi-pose estimation Tensorflow Model"}}]},{kind:"MdxPage",name:"tensorflow",route:"/v1/models/tensorflow"},{kind:"Meta",data:{tensorflow:"Tensorflow"}}]},{kind:"MdxPage",name:"models",route:"/v1/models",frontMatter:{title:"Ready to use computer vision models",description:"A list of ready to use computer vision models with Python APIs"}},{kind:"MdxPage",name:"rest-api",route:"/v1/rest-api",frontMatter:{title:"Pipeless REST API",description:"Documentation about the endpoints exposed by a running Pipeless instance"}},{kind:"MdxPage",name:"restart-policy",route:"/v1/restart-policy",frontMatter:{title:"Processing Restart Policy",description:"Documentation about the restart policy for stream processing"}},{kind:"MdxPage",name:"troubleshooting",route:"/v1/troubleshooting",frontMatter:{title:"Troubleshooting your Pipeless application",description:"General guidance and common issues when running your Pipeless application"}}]},{kind:"MdxPage",name:"v1",route:"/v1",frontMatter:{title:"Pipeless v1.x",description:"Documentation for Pipeless ver

1sions 1.x. The open-source computer vision framework"}}],flexsearch:{codeblocks:!0},title:"Key-Value Store usage",headings:d},pageNextRoute:"/v1/kvstore",nextraLayout:s.ZP,themeConfig:a.Z};t.default=(0,i.j)(p)}},function(e){e.O(0,[13,996,774,888,179],function(){return e(e.s=578)}),_N_E=e.O()}]);