Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 0 additions & 23 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,6 @@ This project was announced by [AOSSIE](https://aossie.org/), an umbrella organiz
<div style="width:25%">
<h2>Backend Python</h2>
<ul>
<li>
<a href="./backend/backend_python/setup">
Setup
</a>
</li>
<li>
<a href="./backend/backend_python/database">
Database
Expand All @@ -56,34 +51,16 @@ This project was announced by [AOSSIE](https://aossie.org/), an umbrella organiz
<div style="width:25%">
<h2>Backend Rust</h2>
<ul>
<li>
<a href="./backend/backend_rust/setup">
Setup
</a>
</li>
<li>
<a href="./backend/backend_rust/api">
API
</a>
</li>
<li>
<a href="./backend/docker-setup.md">Docker setup</a>
</li>
</ul>
</div>
<div style="width:25%">
<h2>Frontend</h2>
<ul>
<li>
<a href="./frontend/setup">
Setup
</a>
</li>
<li>
<a href="./frontend/docker-setup.md">
Docker Setup
</a>
</li>
<li>
<a href="./frontend/ui-components">
UI Components
Expand Down
37 changes: 29 additions & 8 deletions docs/overview/features.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,37 @@
# PictoPy Features

!!! note "Gallery Applicaiton" - Smart tagging of photos based on detected objects, faces and their recognition - Traditional gallery features of album management.
### Gallery Application

!!! tip "Advanced Image Analysis" - Object detection using YOLOv8, enabling identification of various items in photos - Facial recognition powered by FaceNet, allowing for face detection and clustering
- **Intelligent Photo Tagging**: Automatically tags photos based on detected objects, faces, and facial recognition.
- **Traditional Gallery Management**: Complete album organization and management tools.

!!! success "Privacy-Focused Design" - Offline functionality ensuring user data remains on the local machine - No reliance on remote servers for image processing or analysis - Models are stored locally and can be changed according to user needs
### Advanced Image Analysis

!!! abstract "Data Handling and Parallel Processing" - Utilizes SQLite databases for lightweight and efficient storage of photo metadata, face embeddings, and album information - Implements background processing for handling large volumes of images without impacting user experience - Uses `asyncio` in the back to process images without blocking the frontend
- Object detection using **YOLOv8** for identifying various items in images
- Face detection and clustering powered by **FaceNet**.

!!! example "Smart Search and Retrieval" - Enables searching for photos based on detected objects, faces, or other metadata - Supports finding related images based on facial similarity or content
### Privacy-Focused Design

!!! info "Cross-Platform Compatibility" - Designed to work across different operating systems
- **Entirely offline**: All data stays on your local machine.
- No reliance on remote servers for processing.
- Models are stored locally and customizable by the user.

### Efficient Data Handling & Processing

- Lightweight **SQLite** database for storing image metadata, face embeddings, and album info.
- Background image processing using `asyncio` for a smooth UI experience.

### Smart Search & Retrieval

- Search photos based on:
- Detected objects
- Recognized faces
- Embedded metadata
- Find visually or semantically similar images

### Cross-Platform Compatibility

- Available on major operating systems (Windows, macOS, Linux)

## Technical Stack

Expand All @@ -25,9 +46,9 @@
| Object Detection | YOLOv8 |
| Face Recognition | FaceNet |
| API Framework | FastAPI |
| State Management | React Hooks |
| State Management | Redux Toolkit |
| Styling | Tailwind CSS |
| Routing | React Router |
| UI Components | Radix UI |
| UI Components | ShadCN |
| Build Tool | Vite |
| Type Checking | TypeScript |
6 changes: 3 additions & 3 deletions docs/setup.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Setup Instructions

**Please refer to the [README.md](https://github.com/AOSSIE-Org/PictoPy/blob/main/README.md#setup) file for complete setup instructions.**
**Please refer to the [CONTRIBUTING.md](https://github.com/AOSSIE-Org/PictoPy/blob/main/CONTRIBUTING.md) file for complete setup instructions.**

## Available Setup Methods

Expand All @@ -13,5 +13,5 @@ The README.md file contains detailed instructions for:
## Quick Links

- [Main Repository](https://github.com/AOSSIE-Org/PictoPy)
- [Setup Section in README](https://github.com/AOSSIE-Org/PictoPy/blob/main/README.md#setup)
- [Troubleshooting](https://github.com/AOSSIE-Org/PictoPy/blob/main/README.md#troubleshooting)
- [Setup Section in CONTRIBUTING.md](https://github.com/AOSSIE-Org/PictoPy/blob/main/CONTRIBUTING.md#setup)
- [Troubleshooting](https://github.com/AOSSIE-Org/PictoPy/blob/main/CONTRIBUTING.md#troubleshooting)
Loading