codeproject.ai/index.html


<!doctype html>
<html lang="en" class="no-js">
  <head>
    
      <meta charset="utf-8">
      <meta name="viewport" content="width=device-width,initial-scale=1">
      
        <meta name="description" content="A Guide to using and developing with CodeProject.AI Server">
      
      
        <link rel="next" href="install/install_on_windows.html">
      
      
      <link rel="icon" href="assets/images/favicon.png">
      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
    
    
        <title>CodeProject.AI Server - CodeProject.AI Server v2.9.5</title>
      
    
      <link rel="stylesheet" href="assets/stylesheets/main.6f8fc17f.min.css">
      
      
        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
        <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
      
    
      <link rel="stylesheet" href="css/site.css">
    
    <script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
    
      
<script id="__analytics">function __md_analytics(){function e(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],e("js",new Date),e("config","G-YZNPNQ0F2S"),document.addEventListener("DOMContentLoaded",(function(){document.forms.search&&document.forms.search.query.addEventListener("blur",(function(){this.value&&e("event","search",{search_term:this.value})}));document$.subscribe((function(){var t=document.forms.feedback;if(void 0!==t)for(var a of t.querySelectorAll("[type=submit]"))a.addEventListener("click",(function(a){a.preventDefault();var n=document.location.pathname,d=this.getAttribute("data-md-value");e("event","feedback",{page:n,data:d}),t.firstElementChild.disabled=!0;var r=t.querySelector(".md-feedback__note [data-md-value='"+d+"']");r&&(r.hidden=!1)})),t.hidden=!1})),location$.subscribe((function(t){e("config","G-YZNPNQ0F2S",{page_path:t.pathname})}))}));var t=document.createElement("script");t.async=!0,t.src="https://www.googletagmanager.com/gtag/js?id=G-YZNPNQ0F2S",document.getElementById("__analytics").insertAdjacentElement("afterEnd",t)}</script>
  
    <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  

  </head>
  
  
    <body dir="ltr">
  
    
    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
    <label class="md-overlay" for="__drawer"></label>
    <div data-md-component="skip">
      
        
        <a href="#cut-to-the-chase-how-do-i-play-with-it" class="md-skip">
          Skip to content
        </a>
      
    </div>
    <div data-md-component="announce">
      
    </div>
    
    
<header class="md-header md-header--shadow" data-md-component="header">
  <nav class="md-header__inner md-grid" aria-label="Header">
    <a href="https://github.com/codeproject/CodeProject.AI-Server" title="CodeProject.AI Server v2.9.5" class="md-header__button md-logo" aria-label="CodeProject.AI Server v2.9.5" data-md-component="logo">
      
  <img src="img/FavIcon.png" alt="logo">

    </a>
    <label class="md-header__button md-icon" for="__drawer">
      
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
    </label>
    <div class="md-header__title" data-md-component="header-title">
      <div class="md-header__ellipsis">
        <div class="md-header__topic">
          <span class="md-ellipsis">
            CodeProject.AI Server v2.9.5
          </span>
        </div>
        <div class="md-header__topic" data-md-component="header-topic">
          <span class="md-ellipsis">
            
              CodeProject.AI Server
            
          </span>
        </div>
      </div>
    </div>
    
    
      <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
    
    
      <label class="md-header__button md-icon" for="__search">
        
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
      </label>
      <div class="md-search" data-md-component="search" role="dialog">
  <label class="md-search__overlay" for="__search"></label>
  <div class="md-search__inner" role="search">
    <form class="md-search__form" name="search">
      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
      <label class="md-search__icon md-icon" for="__search">
        
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
        
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
      </label>
      <nav class="md-search__options" aria-label="Search">
        
        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
          
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
        </button>
      </nav>
      
    </form>
    <div class="md-search__output">
      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
        <div class="md-search-result" data-md-component="search-result">
          <div class="md-search-result__meta">
            Initializing search
          </div>
          <ol class="md-search-result__list" role="presentation"></ol>
        </div>
      </div>
    </div>
  </div>
</div>
    
    
  </nav>
  
</header>
    
    <div class="md-container" data-md-component="container">
      
      
      <main class="md-main" data-md-component="main">
        <div class="md-main__inner md-grid">
          
            
              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    

<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  <label class="md-nav__title" for="__drawer">
    <a href="https://github.com/codeproject/CodeProject.AI-Server" title="CodeProject.AI Server v2.9.5" class="md-nav__button md-logo" aria-label="CodeProject.AI Server v2.9.5" data-md-component="logo">
      
  <img src="img/FavIcon.png" alt="logo">

    </a>
    CodeProject.AI Server v2.9.5
  </label>
  
  <ul class="md-nav__list" data-md-scrollfix>
    
      
    <li class="md-nav__item md-nav__item--active">
      
      <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
      
      
        <label class="md-nav__link md-nav__link--active" for="__toc">
          
  
  <span class="md-ellipsis">
    Home
  </span>
  

          <span class="md-nav__icon md-icon"></span>
        </label>
      
      <a href="index.html" class="md-nav__link md-nav__link--active">
        
  
  <span class="md-ellipsis">
    Home
  </span>
  

      </a>
      
        
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  
  
    <label class="md-nav__title" for="__toc">
      <span class="md-nav__icon md-icon"></span>
      Table of contents
    </label>
    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
      
        <li class="md-nav__item">
  <a href="#cut-to-the-chase-how-do-i-play-with-it" class="md-nav__link">
    <span class="md-ellipsis">
      Cut to the chase: how do I play with it?
    </span>
  </a>
  
    <nav class="md-nav" aria-label="Cut to the chase: how do I play with it?">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#1-running-and-playing-with-the-features" class="md-nav__link">
    <span class="md-ellipsis">
      1: Running and playing with the features
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#2-running-and-debugging-the-code" class="md-nav__link">
    <span class="md-ellipsis">
      2: Running and debugging the code
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#how-do-i-use-it-in-my-application" class="md-nav__link">
    <span class="md-ellipsis">
      How do I use it in my application?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#what-does-it-include" class="md-nav__link">
    <span class="md-ellipsis">
      What does it include?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#what-can-it-do" class="md-nav__link">
    <span class="md-ellipsis">
      What can it do?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#our-goals" class="md-nav__link">
    <span class="md-ellipsis">
      Our Goals
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#roadmap" class="md-nav__link">
    <span class="md-ellipsis">
      Roadmap
    </span>
  </a>
  
</li>
      
    </ul>
  
</nav>
      
    </li>
  

    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
        
          
          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
            
  
  <span class="md-ellipsis">
    CodeProject.AI: Start here
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_2">
            <span class="md-nav__icon md-icon"></span>
            CodeProject.AI: Start here
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="install/install_on_windows.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    CodeProject.AI on Windows
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="install/running_in_docker.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    CodeProject.AI in Docker
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="install/install_on_linux.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    CodeProject.AI on Linux
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="install/install_on_macos.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    CodeProject.AI on macOS
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="install/install_on_jetson.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    CodeProject.AI on a Jetson
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="features/mesh.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    CodeProject.AI Server Mesh
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="features/modules.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    CodeProject.AI Modules
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
        
          
          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
            
  
  <span class="md-ellipsis">
    Development Guide
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_3">
            <span class="md-nav__icon md-icon"></span>
            Development Guide
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="devguide/install_dev.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Setting up the Dev Environment
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="devguide/modulesettings_json.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    The modulesettings files
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="devguide/install_scripts.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Install scripts
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="devguide/python_req_text.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Python requirements files
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="devguide/queues_and_routes.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Queues and Routes
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="devguide/triggers.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Using Triggers
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_7" >
        
          
          <label class="md-nav__link" for="__nav_3_7" id="__nav_3_7_label" tabindex="0">
            
  
  <span class="md-ellipsis">
    Adding New Modules
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_7_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_3_7">
            <span class="md-nav__icon md-icon"></span>
            Adding New Modules
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="devguide/module_examples/adding_new_modules.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    So you want to add new module to CodeProject.AI
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="devguide/module_examples/add_python_module.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Adding your own Python module
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="devguide/module_examples/add_net_module-sentiment.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Adding your own .NET module: Sentiment Analysis
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="devguide/module_examples/add_net_module-portrait.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Adding your own .NET module: Portrait Filter
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item">
      <a href="why/how_to_add_AI_to_an_app.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    How to add AI to an Application
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="why/integrations.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Who is using CodeProject.AI?
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
        
          
          <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
            
  
  <span class="md-ellipsis">
    API & Settings
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_4">
            <span class="md-nav__icon md-icon"></span>
            API & Settings
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="api/api_reference.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    API Reference
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="api/module_settings.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Module Settings
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
        
          
          <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
            
  
  <span class="md-ellipsis">
    FAQ
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_5">
            <span class="md-nav__icon md-icon"></span>
            FAQ
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="faq/index.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    CodeProject.AI Server FAQ
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="faq/windows-installer.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Windows Installer
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="faq/docker.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Using Docker
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="faq/mesh-faq.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Mesh
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="faq/virtual-machine.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Virtual Machines
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="faq/gpu.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    GPUs, TPUs, NPUs
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="faq/coral.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Coral USB Accelerator
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="faq/raspberry-pi.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Raspberry Pi
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="faq/jetson.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Jetson Nano Dev Kit
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="faq/home-assistant.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Home Assistant Integration
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="faq/blue-iris.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Blue Iris Webcam Software
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="faq/dev-environment.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Build and Debug the Code
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="faq/ubuntu-installer.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Ubuntu / WSL
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
        
          
          <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
            
  
  <span class="md-ellipsis">
    About
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_6">
            <span class="md-nav__icon md-icon"></span>
            About
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="about/about.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    About CodeProject.AI
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="about/license.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    License
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="about/release-notes.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Release Notes
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://github.com/codeproject/CodeProject.AI-Server" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Project Home
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://github.com/codeproject/CodeProject.AI-Server/discussions" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Discussions
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

  </ul>
</nav>
                  </div>
                </div>
              </div>
            
            
              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    

<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  
  
    <label class="md-nav__title" for="__toc">
      <span class="md-nav__icon md-icon"></span>
      Table of contents
    </label>
    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
      
        <li class="md-nav__item">
  <a href="#cut-to-the-chase-how-do-i-play-with-it" class="md-nav__link">
    <span class="md-ellipsis">
      Cut to the chase: how do I play with it?
    </span>
  </a>
  
    <nav class="md-nav" aria-label="Cut to the chase: how do I play with it?">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#1-running-and-playing-with-the-features" class="md-nav__link">
    <span class="md-ellipsis">
      1: Running and playing with the features
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#2-running-and-debugging-the-code" class="md-nav__link">
    <span class="md-ellipsis">
      2: Running and debugging the code
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#how-do-i-use-it-in-my-application" class="md-nav__link">
    <span class="md-ellipsis">
      How do I use it in my application?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#what-does-it-include" class="md-nav__link">
    <span class="md-ellipsis">
      What does it include?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#what-can-it-do" class="md-nav__link">
    <span class="md-ellipsis">
      What can it do?
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#our-goals" class="md-nav__link">
    <span class="md-ellipsis">
      Our Goals
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#roadmap" class="md-nav__link">
    <span class="md-ellipsis">
      Roadmap
    </span>
  </a>
  
</li>
      
    </ul>
  
</nav>
                  </div>
                </div>
              </div>
            
          
            <div class="md-content" data-md-component="content">
              <article class="md-content__inner md-typeset">
                
                  
  <h1>Home</h1>

<p><span style='float:right;margin-top:-70px'>
<img alt="Windows" class="middle" src="img/windows.svg" width="30" /> &nbsp;
<img alt="macOS" class="middle" src="img/macos.svg" width="30" /> &nbsp;
<img alt="macOS" class="middle" src="img/apple-silicon.svg" width="30" /> &nbsp;
<img alt="Ubuntu" class="middle" src="img/Ubuntu.svg" width="30" /> &nbsp;
<img alt="Debian" class="middle" src="img/Debian.svg" width="25" /> &nbsp;
<img alt="Raspberry Pi" class="middle" src="img/RaspberryPi64.svg" width="30" /> &nbsp;
<img alt="Orange Pi" class="middle" src="img/orangepi.jpg" width="30" /> &nbsp;
<img alt="Jetson Nano" class="middle" src="img/Jetson.png" width="30" /> &nbsp;
<img alt="Docker" class="middle" src="img/docker.svg" width="30" /> &nbsp;
<img alt="Visual Studio" class="middle" src="img/VisualStudio.svg" width="30" /> &nbsp;
<img alt="Visual Studio Code" class="middle" src="img/VisualStudioCode.svg" width="30" /> 
</span></p>
<p><center>
<br>
<img alt="CodeProjectAI" src="img/codeprojectAI-black.svg" width="400" />
<br>
</center></p>
<p><a class="md-button md-button--primary tight" href="https://hub.docker.com/r/codeproject/ai-server">Docker Images</a>
<a class="md-button md-button--primary tight" href="https://codeproject.github.io/codeproject.ai/latest.html">Windows Installer</a> &nbsp;
<a class="md-button tight" href="api/api_reference.html">API Docs</a> &nbsp;
<a class="md-button tight" href="faq/index.html">FAQs</a> &nbsp;
<a class="md-button tight" href="https://github.com/codeproject/CodeProject.AI-Server">GitHub</a> &nbsp;
<a class="md-button md-outline-button--primary tight" href="https://github.com/codeproject/CodeProject.AI-Server/discussions">Discussions</a> </p>
<p></center></p>
<p>CodeProject.AI Server is a self-hosted, free and Open Source Artificial Intelligence Server for any 
platform, any language. Just like you would install a database server to provide data storage, you
install CodeProject.AI Server to provide AI services.</p>
<p>It can be installed locally, requires no off-device or out of network data transfer, and is easy to
use.</p>
<p><img alt="Object detection" src="img/DetectThings.png" title="Object detection example" /></p>
<p><strong>AI programming is something every single developer should be aware of</strong>. We wanted a fun project we could use to help teach developers and get them involved in AI. We'll be using CodeProject.AI as a focus for articles and exploration to make it fun and painless to learn AI programming.</p>
<p><strong>We got sick of fighting versions and libraries and models</strong> and being blocked by tiny annoying things every step of the way. So we put put this together so we could save you the frustation. We'll take care of the housekeeping, you focus on the code.</p>
<p><strong>We don't always want our personal data in the cloud</strong>. It should always be your choice as to who sees your data. </p>
<p><big><strong>Help us make this something amazing!</strong></big></p>
<h2 id="cut-to-the-chase-how-do-i-play-with-it">Cut to the chase: how do I play with it?</h2>
<h4 id="1-running-and-playing-with-the-features">1: Running and playing with the features</h4>
<ol>
<li><a href="https://codeproject.github.io/codeproject.ai/latest.html"><strong>Download the latest version</strong></a>, install, and launch the shortcut to the server's dashboard on your desktop.</li>
<li>On the dashboard, top and center, is a link to the CodeProject.AI Explorer. Open that and play!</li>
</ol>
<h4 id="2-running-and-debugging-the-code">2: Running and debugging the code</h4>
<p>Read our <a href="devguide/install_dev.html">quick guide</a> to setting up and running CodeProject.AI in Visual Studio Code or Visual Studio.</p>
<h2 id="how-do-i-use-it-in-my-application">How do I use it in my application?</h2>
<p>Here's an example of using the API for scene detection using a simple JavaScript call:</p>
<div class="highlight"><span class="filename">HTML</span><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="p">&lt;</span><span class="nt">html</span><span class="p">&gt;</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="p">&lt;</span><span class="nt">body</span><span class="p">&gt;</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>Detect the scene in this file: <span class="p">&lt;</span><span class="nt">input</span> <span class="na">id</span><span class="o">=</span><span class="s">&quot;image&quot;</span> <span class="na">type</span><span class="o">=</span><span class="s">&quot;file&quot;</span> <span class="p">/&gt;</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="p">&lt;</span><span class="nt">input</span> <span class="na">type</span><span class="o">=</span><span class="s">&quot;button&quot;</span> <span class="na">value</span><span class="o">=</span><span class="s">&quot;Detect Scene&quot;</span> <span class="na">onclick</span><span class="o">=</span><span class="s">&quot;detectScene(image)&quot;</span> <span class="p">/&gt;</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="p">&lt;</span><span class="nt">script</span><span class="p">&gt;</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="kd">function</span><span class="w"> </span><span class="nx">detectScene</span><span class="p">(</span><span class="nx">fileChooser</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="w">    </span><span class="kd">var</span><span class="w"> </span><span class="nx">formData</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="nx">FormData</span><span class="p">();</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="w">    </span><span class="nx">formData</span><span class="p">.</span><span class="nx">append</span><span class="p">(</span><span class="s1">&#39;image&#39;</span><span class="p">,</span><span class="w"> </span><span class="nx">fileChooser</span><span class="p">.</span><span class="nx">files</span><span class="p">[</span><span class="mf">0</span><span class="p">]);</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a>
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a><span class="w">    </span><span class="nx">fetch</span><span class="p">(</span><span class="s1">&#39;http://localhost:32168/v1/vision/detect/scene&#39;</span><span class="p">,</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="w">        </span><span class="nx">method</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;POST&quot;</span><span class="p">,</span>
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a><span class="w">        </span><span class="nx">body</span><span class="o">:</span><span class="w"> </span><span class="nx">formData</span>
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a><span class="w">    </span><span class="p">})</span>
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a><span class="w">    </span><span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">response</span><span class="w"> </span><span class="p">=&gt;</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a><span class="w">        </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">response</span><span class="p">.</span><span class="nx">ok</span><span class="p">)</span><span class="w"> </span><span class="nx">response</span><span class="p">.</span><span class="nx">json</span><span class="p">().</span><span class="nx">then</span><span class="p">(</span><span class="nx">data</span><span class="w"> </span><span class="p">=&gt;</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a><span class="w">            </span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="sb">`Scene is </span><span class="si">${</span><span class="nx">data</span><span class="p">.</span><span class="nx">label</span><span class="si">}</span><span class="sb">, </span><span class="si">${</span><span class="nx">data</span><span class="p">.</span><span class="nx">confidence</span><span class="si">}</span><span class="sb"> confidence`</span><span class="p">)</span>
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a><span class="w">        </span><span class="p">});</span>
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a><span class="w">    </span><span class="p">});</span>
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a><span class="p">}</span>
<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a><span class="p">&lt;/</span><span class="nt">script</span><span class="p">&gt;</span>
<a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a><span class="p">&lt;/</span><span class="nt">body</span><span class="p">&gt;</span>
<a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a><span class="p">&lt;/</span><span class="nt">html</span><span class="p">&gt;</span>
</code></pre></div>
<p>You can include the CodeProject.AI installer (or just a link to the latest version of the installer) in your own apps and installers and voila, you have an AI enabled app.</p>
<h2 id="what-does-it-include">What does it include?</h2>
<p>CodeProject.AI includes</p>
<ol>
<li><strong>A HTTP REST API Server.</strong> The server listens for requests from other apps, passes them to the backend analysis services for processing, and then passes the results back to the caller. It runs as a simple self contained web service on your device.</li>
<li><strong>Backend Analysis services</strong>.  The brains of the operation is in the analysis services sitting behind the front end API. All processing of data is done on the current machine. No calls to the cloud and no data leaving the device.</li>
<li><strong>The Source Code</strong>, naturally.</li>
</ol>
<h2 id="what-can-it-do">What can it do?</h2>
<p>CodeProject.AI can currently</p>
<ul>
<li>Detect objects in images</li>
<li>Detect faces in images</li>
<li>Transform a face into an anime-style cartoon</li>
<li>Read text and license plates</li>
<li>Detect the type of scene represented in an image</li>
<li>Recognise faces that have been registered with the service</li>
<li>Pull out the most important sentences in text to generate a text summary</li>
<li>Remove the background automatically from images</li>
<li>Blur the background of images to produce a portrait effect</li>
<li>Generate a sentiment score for text</li>
</ul>
<p>We will be constantly expanding the feature list.</p>
<p><strong>Please note</strong> that the Windows Install and Docker versions only contain object detection modules. Other modules can be installed via the dashboard at runtime.</p>
<h2 id="our-goals">Our Goals</h2>
<ol>
<li><strong>To promote AI development</strong> and inspire the AI developer community to dive in and have a go. AI is here, it's in demand, and it's a huge paradigm change in the industry. Whether you like AI or not, developers owe it to themselves to experiment in and familiarise themselves with the  technology. This is CodeProject.AI: a demonstration, an explorer, a learning tool, and a library and service that can be used out of the box.</li>
<li><strong>To make AI development <em>easy</em></strong>. It's not that AI development is that hard. It's that there are so, so many options. Our architecture is designed to allow any AI implementation to find a home in our system, and for our service to be callable from any language.</li>
<li><strong>To focus on core use-cases</strong>. We're deliberately not a solution for everyone. Instead we're a solution for common day-to-day needs. We will be adding dozens of modules and scores of AI capabilities to our system, but our goal is always clarity and simplicity over a 100% solution.</li>
<li><strong>To tap the expertise of the Developer Community</strong>. We're not experts but we know a developer or two out there who are. The true power of CodeProject.AI comes from the contributions and improvements from our AI community.</li>
</ol>
<h2 id="roadmap">Roadmap</h2>
<p>The following features will be added over the coming weeks and months</p>
<ol>
<li>More modules and a streamlined plugin architecture</li>
<li>A GUI management system</li>
<li>GPU support across a range of graphics cards and accelerators</li>
<li>More analysis services</li>
</ol>


              </article>
            </div>
          
          
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
        </div>
        
          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
  
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
  Back to top
</button>
        
      </main>
      
        <footer class="md-footer">
  
  <div class="md-footer-meta md-typeset">
    <div class="md-footer-meta__inner md-grid">
      <div class="md-copyright">
  
    <div class="md-copyright__highlight">
      CodeProject Solutions Inc
    </div>
  
  
    Made with
    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
      Material for MkDocs
    </a>
  
</div>
      
    </div>
  </div>
</footer>
      
    </div>
    <div class="md-dialog" data-md-component="dialog">
      <div class="md-dialog__inner md-typeset"></div>
    </div>
    
    
    <script id="__config" type="application/json">{"base": ".", "features": ["navigation.sections", "navigation.top"], "search": "assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
    
    
      <script src="assets/javascripts/bundle.83f73b43.min.js"></script>
      
    
  </body>
</html>