Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Jsakkos committed Dec 25, 2024
1 parent 683e3ea commit 1403597
Show file tree
Hide file tree
Showing 6 changed files with 675,953 additions and 9 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ wheels/

# Virtual environments
.venv
site/
Empty file.
78 changes: 78 additions & 0 deletions docs/getting-started/configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# Configuration Guide

Learn how to configure Lightroom AI Tagger for optimal performance and results.

## Configuration Options

### Command Line Options

These settings can be configured per run:

| Option | Description | Default | Example |
| --------------- | ------------------------ | ------------------------- | ---------------------------- |
| `threshold` | Minimum confidence score | 0.5 | `--threshold 0.3` |
| `max-keywords` | Keywords per image | 20 | `--max-keywords 30` |
| `keywords-file` | Custom keywords list | Foundation List 2.0.1.txt | `--keywords-file custom.txt` |


## Keywords File Format

The keywords file should follow this format:

```
[Category Name]
keyword1
keyword2 {alias1, alias2}
subcategory1
subcategory2 {alt1, alt2}
```

Example:
```
[Nature]
landscape
mountain {mountains, mountainous}
alpine
rocky {rocks, rocky terrain}
```

## Performance Tuning

### GPU Acceleration

Enable GPU support by:
1. Installing CUDA drivers
2. Setting environment variables:
```bash
export CUDA_VISIBLE_DEVICES=0
```

### Memory Usage

Control memory usage with:
- Batch size adjustments
- Image size limits
- Process count settings

## Example Configurations

### Low Accuracy Mode
```bash
lr-autotag --catalog "photos.lrcat" \
--threshold 0.25 \
--max-keywords 30
```

### Fast Processing Mode
```bash
lr-autotag --catalog "photos.lrcat" \
--threshold 0.5 \
--max-keywords 15
```

### Custom Keywords Mode
```bash
lr-autotag --catalog "photos.lrcat" \
--keywords-file "custom_keywords.txt" \
--threshold 0.4
```
1 change: 0 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,3 @@ lr-autotag --image-folder "path/to/images"

- Read the [Installation Guide](getting-started/installation.md) for detailed setup instructions
- Check the [Basic Usage](getting-started/basic-usage.md) guide to get started
- Review [Advanced Features](advanced/custom-keywords.md) for power users
Loading

0 comments on commit 1403597

Please sign in to comment.