157 lines
6.5 KiB
Markdown
157 lines
6.5 KiB
Markdown
<h1 align="center">
|
||
OpenDBM
|
||
</h1>
|
||
|
||
<div align="center">
|
||
<img width="400" alt="GitHub Actions for deploying to GitHub Pages with Static Site Generators" src="https://raw.githubusercontent.com/AiCure/open_dbm/master/images/odbm.png">
|
||
|
||
[](https://pypi.org/project/opendbm/)
|
||
[](https://anaconda.org/r/r-odbc)
|
||
[](https://github.com/AiCure/open_dbm/blob/master/license.txt)
|
||
[](https://github.com/AiCure/open_dbm/actions/workflows/open_dbm-code-checking.yml?query=branch%3Amaster++)
|
||
[](https://github.com/AiCure/open_dbm/actions/workflows/open_dbm-code-checking.yml?query=branch%3Amaster++)
|
||
[](https://github.com/psf/black)
|
||
[](https://pycqa.github.io/isort/)
|
||
</div>
|
||
|
||
# Supported OS Platforms
|
||
|
||
OS | Build Status
|
||
----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
||
**Linux** | [](https://github.com/AiCure/open_dbm/actions/workflows/open_dbm-build-checking.yml)
|
||
**Windows** | [](https://github.com/AiCure/open_dbm/actions/workflows/open_dbm-build-checking.yml)
|
||
**macOS-Intel** | [](https://github.com/AiCure/open_dbm/actions/workflows/open_dbm-build-checking.yml)
|
||
|
||
|
||
# What is it
|
||
OpenDBM is a software package that allows for calculation of digital
|
||
biomarkers of health and functioning from video or audio of an individual’s
|
||
behavior. It integrates existing tools for behavioral measurements such as
|
||
facial activity, voice, speech, and movement into a single package for measurement
|
||
of overall behavior.
|
||
|
||
# More About OpenDBM
|
||
|
||
At a modular level, OpenDBM is a library that consists of the following components:
|
||
|
||
| Component | Description |
|
||
| ---- | --- |
|
||
| [**Facial**](https://teebid.github.io/aicure_opendbm/docs/category/api/facial) | An OpenDBM module to get facial attributes |
|
||
| [**Movement**](https://teebid.github.io/aicure_opendbm/docs/category/api/movement) | An OpenDBM module to get movement attributes |
|
||
| [**Acoustic**](https://teebid.github.io/aicure_opendbm/docs/category/api/acoustic) | An OpenDBM module to get acoustic attributes |
|
||
| [**Audio**](https://teebid.github.io/aicure_opendbm/docs/category/api/audio) | An OpenDBM module to get audio attributes |
|
||
|
||
Usually, OpenDBM is used for:
|
||
|
||
- A digital biomaker extraction app
|
||
- A helper tools to give insight of patient condition
|
||
|
||
# Table of Contents
|
||
|
||
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
|
||
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
||
|
||
- [⭐️ Installation](#%EF%B8%8F-installation)
|
||
- [Prerequisites](#prerequisites)
|
||
- [Install Dependencies](#install-dependencies)
|
||
- [OpenDBM Installation](#opendbm-installation)
|
||
- [⭐️ Usage](#%EF%B8%8F-usage)
|
||
- [Basic Usage](#basic-usage)
|
||
- [*Try your first OpenDBM program*](#try-your-first-opendbm-program)
|
||
- [⭐️ More resources](#%EF%B8%8F-more-resources)
|
||
- [⭐️ License](#%EF%B8%8F-license)
|
||
- [⭐️ People](#%EF%B8%8F-people)
|
||
|
||
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
||
|
||
# ⭐️ Installation
|
||
|
||
## Prerequisites (Install Dependencies)
|
||
### With Conda Environment (recommended)
|
||
**Make sure to install conda first at** [anaconda](https://www.anaconda.com/)
|
||
|
||
**On Linux/macOS**
|
||
```bash
|
||
conda install -c conda-forge cmake ffmpeg sox
|
||
```
|
||
**On Windows**
|
||
```bash
|
||
#Make sure to run in Anaconda Prompt, or add conda to the path.
|
||
conda install -c conda-forge ffmpeg sox dlib
|
||
```
|
||
### Without Conda Environment
|
||
[Installation instructions](https://teebid.github.io/aicure_opendbm/docs/dependencies-installation)
|
||
## OpenDBM Installation
|
||
```bash
|
||
pip install opendbm
|
||
```
|
||
|
||
## Model Download ( Facial and Movement Components)
|
||
Make sure you have installed docker and already login to Docker Hub.
|
||
|
||
If you haven't, Find the tutorial [here](https://teebid.github.io/aicure_opendbm/docs/openface-docker-installation)
|
||
```bash
|
||
docker pull opendbmteam/dbm-openface
|
||
```
|
||
|
||
<div align="right">
|
||
<a href="#table-of-contents">Back to TOC ☝️</a>
|
||
</div>
|
||
|
||
# ⭐️ Usage
|
||
## Basic Usage
|
||
### *Try your first OpenDBM program*
|
||
```python
|
||
from opendbm import FacialActivity
|
||
|
||
#make sure Docker is active to access the model
|
||
model = FacialActivity()
|
||
path = "sample.mp4"
|
||
model.fit(path)
|
||
landmark = model.get_landmark()
|
||
```
|
||
|
||
To get the attribute like mean and std is as straighforward as `.mean()`:
|
||
|
||
```python
|
||
landmark.mean()
|
||
landmark.std()
|
||
landmark.to_dataframe() # convert results as pandas dataframe
|
||
```
|
||
|
||
|
||
For more in-depth tutorials about OpenDBM, you can check out:
|
||
|
||
- [Introduction to OpenDBM](https://teebid.github.io/aicure_opendbm/docs/intro)
|
||
- [Advance Guide](https://teebid.github.io/aicure_opendbm/docs/advance)
|
||
- [API Documentation](https://teebid.github.io/aicure_opendbm/docs/category/api)
|
||
|
||
<div align="right">
|
||
<a href="#table-of-contents">Back to TOC ☝️</a>
|
||
</div>
|
||
|
||
# ⭐️ More resources
|
||
- [Our wiki](https://github.com/AiCure/open_dbm/wiki)
|
||
- [OpenDBM 2.0 Documentation](https://docs.google.com/document/d/1O6OUSY9FHFCZfpIWu3Kgg0Q_dyp073xjjQ2K3viEffU/edit#heading=h.rxr2y5t62mwa)
|
||
- [AiCure page](https://aicure.com/opendbm/)
|
||
|
||
<div align="right">
|
||
<a href="#table-of-contents">Back to TOC ☝️</a>
|
||
</div>
|
||
|
||
# ⭐️ License
|
||
OpenDBM is published under the GNU AGPL 3.0 license.
|
||
|
||
|
||
# ⭐️ People
|
||
OpenDBM was developed by Anzar Abbas and Vijay Yadav, alongside Vidya Koesmahargyo and Isaac Galatzer-Levy, from within the Research and Development department at AiCure––a health tech startup in New York. It was made open source in October 2020. You can contact us at opendbm@aicure.com.
|
||
|
||
<div align="right">
|
||
<a href="#table-of-contents">Back to TOC ☝️</a>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|