Skip to content

Getting Started

Welcome to PrimateFace! This guide will help you get up and running quickly.

Overview

PrimateFace is a comprehensive toolkit for primate facial analysis. Whether you're studying behavior, conducting research, or building applications, we'll help you get started.

Quick Navigation

🚀 Installation

Complete setup guide for all platforms and configurations.

⚡ Quickstart

Get running in 5 minutes with our quickstart tutorial.

🗺️ Which Workflow Should I Use?

Decision guide to help you choose the right tools for your task.

Typical First Steps

1. Install PrimateFace

# Quick install
conda env create -f environment.yml
conda activate primateface
pip install -e .

See Installation Guide for detailed instructions.

2. Download Models

python demos/download_models.py

3. Run Your First Detection

python demos/primateface_demo.py process \
    --input sample_image.jpg \
    --det-config demos/mmdet_config.py \
    --det-checkpoint demos/mmdet_checkpoint.pth

4. Explore Further

Based on your needs:

Learning Path

For Researchers

  1. Start with Tutorials to see applications
  2. Follow Core Workflows for your use case
  3. Dive into API Reference for customization

For Developers

  1. Review API Reference for interfaces
  2. Check Framework Integration for your framework
  3. See Contributing to help improve PrimateFace

For Students

  1. Read Concepts for theory
  2. Try Tutorials for hands-on learning
  3. Use Decision Tree to find your workflow

Hardware Requirements

Minimum

  • CPU: 4 cores
  • RAM: 8GB
  • GPU: Optional (CPU mode available)
  • Storage: 10GB
  • CPU: 8+ cores
  • RAM: 16GB+
  • GPU: NVIDIA with 6GB+ VRAM
  • Storage: 50GB for models and data

Getting Help

Next Steps

Ready to dive in? Choose your path:

  1. Quickstart Tutorial - 5-minute hands-on introduction
  2. Decision Tree - Find the right workflow for your needs
  3. Tutorials - Learn through practical examples

Welcome to the PrimateFace community!