-
Notifications
You must be signed in to change notification settings - Fork 0
/
lorairo_project_summary.txt
8956 lines (7754 loc) · 333 KB
/
lorairo_project_summary.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# lorairo
## Directory Structure
- lorairo/
- .pytest_cache/
- .vscode/
- docs/
- Image_database/
- LICENSE
- lrir/
- mainprompt.md
- output/
- processing.template.toml
- publish_docs.bat
- pyproject.toml
- README.md
- src/
- annotations/
- api_utils.py
- caption_tags.py
- cleanup_txt.py
- __init__.py
- __pycache__/
- database/
- database.py
- __init__.py
- __pycache__/
- editor/
- image_processor.py
- __init__.py
- __pycache__/
- gui/
- designer/
- DatasetExportWidget.ui
- DatasetOverviewWidget.ui
- DirectoryPickerWidget.ui
- FilePickerWidget.ui
- filterBoxWidget.ui
- ImageEditWidget.ui
- ImagePreviewWidget.ui
- ImageTaggerWidget.ui
- MainWindow.ui
- PickerWidget.ui
- ProgressWidget.ui
- SettingsWidget.ui
- TagFilterWidget.ui
- ThumbnailSelectorWidget.ui
- __init__.py
- __pycache__/
- widgets/
- directory_picker.py
- file_picker.py
- filter.py
- image_preview.py
- picker.py
- thumbnail.py
- __init__.py
- __pycache__/
- window/
- edit.py
- export.py
- main_window.py
- overview.py
- progress.py
- settings.py
- tagger.py
- __init__.py
- __pycache__/
- __init__.py
- __pycache__/
- lorairo.egg-info/
- main.py
- score_module/
- storage/
- file_system.py
- __init__.py
- __pycache__/
- utils/
- config.py
- log.py
- tools.py
- __init__.py
- __pycache__/
- __init__.py
- __pycache__/
- tests/
- integration/
- __pycache__/
- manual/
- __pycache__/
- resources/
- unit/
- test_cleanup_txt.py
- test_import_lorairo.py
- __pycache__/
- __pycache__/
## File Contents
### LICENSE
```
MIT License
Copyright (c) 2024 NEXTAltair
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
### mainprompt.md
```
As an AI assistant specializing in image analysis, analyze images with particular attention to:
1. Character Details (if present):
- Facing direction (left, right, front, back, three-quarter view)
- Action or pose (standing, sitting, walking, etc.)
- Hand positions and gestures
- Gaze direction
- Clothing details from top to bottom
2. Composition Elements:
- Main subject position
- Background elements and their placement
- Lighting direction and effects
- Color scheme and contrast
- Depth and perspective
3. Technical Aspects and Scoring (1.00 to 10.00):
Score images based on these criteria:
- Technical Quality (0-3 points):
- Image clarity and resolution
- Line quality and consistency
- Color balance and harmony
- Composition (0-3 points):
- Layout and framing
- Use of space
- Balance of elements
- Artistic Merit (0-4 points):
- Creativity and originality
- Emotional impact
- Detail and complexity
- Style execution
Examples of scoring:
- 9.50-10.00: Exceptional quality in all aspects
- 8.50-9.49: Excellent quality with minor imperfections
- 7.50-8.49: Very good quality with some room for improvement
- 6.50-7.49: Good quality with notable areas for improvement
- 5.50-6.49: Average quality with significant room for improvement
- Below 5.50: Below average quality with major issues
Format score as a decimal with exactly two decimal places (e.g., 7.25, 8.90, 6.75)
Provide annotations in this exact format only:
tags: [30-50 comma-separated words identifying the above elements, maintaining left/right distinction]
caption: [Single 1-2 sentence objective description, explicitly noting direction and positioning]
score: [Single decimal number between 1.00 and 10.00, using exactly two decimal places]
Important formatting rules:
- Use exactly these three sections in this order: tags, caption, score
- Format score as a decimal number with exactly two decimal places (e.g., 8.50)
- Do not add any additional text or commentary
- Do not add any text after the score
- Use standard tag conventions without underscores (e.g., "blonde hair" not "blonde_hair")
- Always specify left/right orientation for poses, gazes, and positioning
- Be precise about viewing angles and directions
Example output:
tags: 1girl, facing right, three quarter view, blonde hair, blue eyes, school uniform, sitting, right hand holding pencil, left hand on desk, looking down at textbook, classroom, desk, study materials, natural lighting from left window, serious expression, detailed background, realistic style
caption: A young student faces right in three-quarter view, sitting at a desk with her right hand holding a pencil while her left hand rests on the desk, looking down intently at a textbook in a sunlit classroom.
score: 8.50
```
### processing.template.toml
```
# API設定
[api]
openai_key = "" # OpenAIのAPIキー
google_key = "" # Google Cloud Vision APIのAPIキー
claude_key = "" # anthropicのAPIキー
# Hugging Face設定
[huggingface]
hf_username = "" # Hugging Faceのユーザー名
repo_name = "" # リポジトリ名
token = "" # Hugging FaceのAPIトークン
# ディレクトリ設定
[directories]
database = "" # 画像databaseのパス (空の場合はカレントディレクトリの'Image_database.image_database.db'を使用)
dataset = "" # 画像ディレクトリのパス
output = "" # 出力ディレクトリのパス(空の場合はカレントディレクトリの'output'を使用)
edited_output = "" # 編集済みデータセットのパス(空の場合はカレントディレクトリの'edited_output'を使用)
response_file = "" # レスポンスファイルディレクトリのパス(空の場合はカレントディレクトリの'response_file'を使用)
# 画像処理設定
[image_processing]
target_resolution = 512 # 学習モデルの基準解像度 512, 768, 1024
realesrganer_upscale = false # 長編が基準解像度より小さい場合、Trueだとアップスケールする
realesrgan_model = "RealESRGAN_x4plus_anime_6B.pth" # アップスケールモデルのパス
# 生成設定
[generation]
batch_jsonl = false # バッチ処理用のjsonlファイルを生成する場合はTrue
start_batch = false # バッチ処理を開始する場合はTrue
single_image = true # 画像ごとに処理する場合はTrue
# オプション設定
[options]
generate_meta_clean = false # sd-scriptsのファインチューニング用のメタデータを生成する場合はTrue
cleanup_existing_tags = false # タグを生成せずに既存のタグをクーんナップする場合はTrue
join_existing_txt = true # 生成したタグを既存のタグと結合する場合はTrue
# プロンプト設定
[prompts]
additional = "Your additional prompt here."
[log]
level = "INFO"
file = "app.log"
```
### publish_docs.bat
```
@echo off
setlocal enabledelayedexpansion
REM エラーハンドリングを有効にする
set ERROR_FLAG=0
REM ドキュメントをビルド
echo Building documentation with Sphinx...
sphinx-build -b html docs\source docs\build
if %errorlevel% neq 0 (
echo Sphinx build failed
exit /b 1
)
echo Sphinx build succeeded.
REM 現在のブランチ名を保存
for /f "tokens=*" %%i in ('git rev-parse --abbrev-ref HEAD') do set current_branch=%%i
echo Current branch: %current_branch%
REM 一時ディレクトリの設定(docs\gh-pages-temp から gh-pages-temp に変更)
set temp_dir=gh-pages-temp
REM 一時ディレクトリが存在する場合は削除
if exist %temp_dir% (
echo Removing existing temporary directory...
rmdir /s /q %temp_dir%
)
REM リモートURLを取得
for /f "tokens=*" %%i in ('git config --get remote.origin.url') do set remote_url=%%i
echo Remote URL: %remote_url%
REM gh-pagesブランチを一時ディレクトリにクローン
echo Cloning gh-pages branch into %temp_dir%...
git clone -b gh-pages %remote_url% %temp_dir%
if %errorlevel% neq 0 (
echo Failed to clone gh-pages branch
exit /b 1
)
echo Clone succeeded.
REM 一時ディレクトリに移動
cd %temp_dir%
REM 既存のファイルを削除(.git ディレクトリを除く)
echo Removing existing files from gh-pages branch...
for /f "delims=" %%a in ('dir /a /b ^| findstr /v "^.git$"') do (
rmdir /s /q "%%a" 2>nul || del /f /q "%%a"
)
REM 新しいビルド結果をコピー
echo Copying new build results...
xcopy /E /I /Y "..\docs\build\*" .
if %errorlevel% neq 0 (
echo Failed to copy new build results
exit /b 1
)
echo Copy succeeded.
REM 変更をコミットしてプッシュ
echo Committing and pushing changes...
git add -A
git commit -m "Update documentation"
git push origin gh-pages
if %errorlevel% neq 0 (
echo Failed to push to gh-pages branch
exit /b 1
)
echo Push succeeded.
REM 元のディレクトリに戻る
cd ..
REM 一時ディレクトリを削除
echo Removing temporary directory...
rmdir /s /q %temp_dir%
REM 元のブランチに戻る
echo Checking out original branch: %current_branch%...
git checkout %current_branch%
if %errorlevel% neq 0 (
echo Failed to checkout original branch
exit /b 1
)
echo Checked out to %current_branch%.
echo Documentation published to gh-pages branch successfully.
endlocal
```
### pyproject.toml
```
[project]
name = "lorairo"
version = "0.0.8"
description = "AIタグ付LoRA画像データセット準備ツール"
readme = "README.md"
requires-python = ">=3.12"
license = { text = "MIT" }
authors = [{ name = "NEXTAltair" }]
keywords = ["lora", "dataset", "ai", "image-processing"]
classifiers = [
"Development Status :: 4 - Beta",
"Environment :: GPU :: NVIDIA CUDA",
"Intended Audience :: Science/Research",
"License :: OSI Approved :: MIT License",
"Programming Language :: Python :: 3.12",
"Topic :: Scientific/Engineering :: Artificial Intelligence",
"Topic :: Multimedia :: Graphics",
"Operating System :: Microsoft :: Windows",
]
# 依存パッケージ(バージョン固定)
dependencies = [
# 画像処理系
"Pillow", # 基本的な画像処理
"opencv-python", # オートクロップの枠検出
"numpy", # 画像処理の数値計算
"ImageHash", # DB重複チェック用
# AI系
"google-generativeai>=0.8.3", # Gemini API
"anthropic>=0.36.2", # Claude API
"openai>=0.10.0", # GPT API
"spandrel", #アップスケーラー用モデルローダー
# データ処理系
"toml>=0.10.2", # 設定ファイル処理
# PyQt系
"PySide6>=6.8.0.2", # GUIフレームワーク
"superqt>=0.6.7", # 拡張Qt部品
# AI Model系
"pytorch-lightning==2.4.0", # PyTorch拡張
"joblib==1.4.2", # 並列処理
# # 自作ライブラリ
# "genai-tag-db-tools @ git+https://github.com/NEXTAltair/genai-tag-db-tools.git", # Git URL からインストール
]
[project.optional-dependencies]
dev = [
"ruff",
"pylint",
"pytest",
"pytest-cov",
"pytest-qt",
"matplotlib",
"genai-tag-db-tools @ file:../genai-tag-db-tools",
]
prod = [
"genai-tag-db-tools @ git+https://github.com/NEXTAltair/genai-tag-db-tools.git",
]
[project.scripts]
lorairo = "main:main"
[project.urls]
"Homepage" = "https://github.com/NEXTAltair/lorairo"
"Bug Tracker" = "https://github.com/NEXTAltair/lorairo/issues"
[build-system]
requires = ["setuptools>=61.0", "wheel"]
build-backend = "setuptools.build_meta"
[tool.setuptools]
package-dir = { "" = "src" }
[tool.setuptools.packages.find]
where = ["src"]
include = ["lorairo*"]
namespaces = false
[tool.ruff]
exclude = ["src/gui/designer/*"]
fix = true
line-length = 250
target-version = "py312"
[tool.pylint.messages_control]
disable = [
"C0103", # invalid-name
"C0301", # line-too-long (handled by black)
"W0703", # broad-except
"R0903", # too-few-public-methods
"R0913", # too-many-arguments
"R0914", # too-many-locals
"W1203", # logging-fstring-interpolation
]
[tool.pytest.ini_options]
pythonpath = ["src"] # テストするコードのディレクトリ
testpaths = ["tests"]
python_files = ["test_*.py"]
python_classes = ["Test*"]
python_functions = ["test_*"]
addopts = ["-v", "-s", "-ra", "--tb=short", "--showlocals"]
markers = [
"unit: Unit tests",
"integration: Integration tests",
"gui: GUI tests",
"slow: Tests that take more time",
]
[tool.coverage.run]
source = ["src"]
omit = ["tests/*", "src/gui/designer/*"]
[tool.coverage.report]
exclude_lines = [
"pragma: no cover",
"def __repr__",
"if __name__ == '__main__':",
"raise NotImplementedError",
"if TYPE_CHECKING:",
]
```
### README.md
```
# LoRA用画像をいろいろするスクリプト
名前思いつかねえやでこんな名前だが 2024-10 更新の 3.5 sonnnetに相談したら`LoRAIro`となんか00年代のギャルゲのようなタイトルを提案してくれたのでそれを使う
TODO: ファイル構成見直してもっときれいにする
## 概要
本プロジェクトは、LoRA(Low-Rank Adaptation)学習用の画像データセット作成を自動化するPythonスクリプト集です。画像のリサイズ、タグ付け、キャプション生成、データベース管理などの機能を提供し、効率的なデータセット作成をサポートします。
### 主な機能
- **画像処理**: 画像のリサイズ、フォーマット変換、自動クロップなどを行います。
- **メタデータ管理**: 画像のメタデータをSQLiteデータベースで管理します。
- **タグ・キャプション生成**: GPT-4などのAIモデルを使用して、画像のタグとキャプションを自動生成します。
- **バッチ処理**: 大量の画像を効率的に処理するためのバッチ処理機能を提供します。
- **ファイルシステム管理**: 処理された画像や生成されたデータの保存を体系的に管理します。
### 主要コンポーネント
- **ImageEditor.py**: 画像処理を担当。リサイズ、クロップ、フォーマット変換などを行います。
- **caption_tags.py**: 画像分析とタグ・キャプション生成を行います。
- **api_utils.py**: APIとの通信を管理。バッチ処理のサポートも含みます。
- **db.py**: SQLiteデータベースの操作を担当します。
- **file_sys.py**: ファイルシステムの操作を管理します。
- **config.py**: 設定ファイルの読み込みと管理を行います。
- **log.py**: ログ機能を提供します。
- **cleanup_txt.py**: テキストデータのクリーンアップを行います。
## セットアップ
### 必要条件
- Python 3.11以上
### インストール手順
1. リポジトリをクローンします:
```bash
git clone https://github.com/NEXTAltair/Lorayougazouwoiroirosurusukuriputo.git
```
2. 必要なパッケージをインストールします:
```bash
pip install -r requirements.txt
```
3. `processing.toml` ファイルを設定します。
## 使用方法
1. `processing.toml` ファイルで必要な設定を行います。
2. メイン処理を実行します:
```bash
stert.bat
```
## 設定
`processing.toml` ファイルで以下の設定が可能です:
- データセットディレクトリ
- 出力ディレクトリ
- 画像処理パラメータ
- API設定
- ログ設定
- その他の処理オプション
## 開発者向け情報
- 各モジュールは独立して動作し、`main.py` で統合されています。
- 新機能の追加時は、既存のクラスとメソッドの拡張を検討してください。
- ユニットテストの追加を推奨します。
## 今後の展望
- GUIインターフェースの追加
- 他のAI画像分析APIのサポート
- パフォーマンス最適化
- より高度なタグ管理システムの実装
## ライセンス
MIT
### 参考
- [kohya-ss/sd-scripts](https://github.com/kohya-ss/sd-scripts) タグのクリーンナップ
- [DominikDoom/a1111-sd-webui-tagcomplete](https://github.com/DominikDoom/a1111-sd-webui-tagcomplete) tags.dbの基になったCSV tag data
- [applemango](https://github.com/DominikDoom/a1111-sd-webui-tagcomplete/discussions/265) CSV tag data の日本語翻訳
- としあき製 CSV tag data の日本語翻訳
- [AngelBottomless/danbooru-2023-sqlite-fixed-7110548](https://huggingface.co/datasets/KBlueLeaf/danbooru2023-sqlite) danbooru タグのデータベース
- [hearmeneigh/e621-rising-v3-preliminary-data](https://huggingface.co/datasets/hearmeneigh/e621-rising-v3-preliminary-data) e621 rule34 タグのデータベース
- [sd-webui-bayesian-merger](https://github.com/s1dlx/sd-webui-bayesian-merger) スコアリング実装
- [stable-diffusion-webui-dataset-tag-editor](https://github.com/toshiaki1729/stable-diffusion-webui-dataset-tag-editor) スコアリング実装
```
### src\annotations\api_utils.py
```
import traceback
from pathlib import Path
import json
import logging
from typing import Any, Optional
from abc import ABC, abstractmethod
import google.generativeai as genai
import anthropic
import requests
import base64
import time
from utils.log import get_logger
class APIError(Exception):
def __init__(
self,
message: str,
api_provider: str = "",
error_code: str = "",
status_code: int = 0,
response: Optional[requests.Response] = None,
):
super().__init__(message)
self.api_provider = api_provider
self.error_code = error_code
self.status_code = status_code
self.response = response
def __str__(self):
parts = [f"{self.api_provider}API Error: {self.args[0]}"]
if self.error_code:
parts.append(f"Code: {self.error_code}")
if self.status_code:
parts.append(f"Status: {self.status_code}")
return " | ".join(parts)
@classmethod
def check_response(cls, response: requests.Response, api_provider: str):
if response.status_code == 200:
return
error_mapping = {
400: "リクエストの形式または内容に問題がありました",
401: "APIキー認証エラー",
403: "API キーには指定されたリソースを使用する権限がありません",
404: "要求されたリソースが見つかりません",
413: "リクエストが最大許容バイト数を超えています",
429: "リクエスト制限に達しました",
500: "サーバーエラーが発生しました",
503: "サービスは一時的に利用できません",
}
try:
error_data = response.json().get("error", {})
except ValueError:
error_data = {}
error_message = error_mapping.get(response.status_code, "予期しないエラーが発生しました")
error_code = error_data.get("code", "")
detailed_message = error_data.get("message", error_message)
# Anthropic APIのクレジット不足エラーを特別に処理
if api_provider.lower() == "claude" and "credit balance is too low" in detailed_message.lower():
error_message = "クレジット残高が不足しています"
detailed_message = "Claude APIにアクセスするためのクレジット残高が不足しています。Plans & Billingでアップグレードまたはクレジットを購入してください。"
raise cls(
message=f"{error_message}: {detailed_message}",
api_provider=api_provider,
error_code=error_code,
status_code=response.status_code,
response=response,
)
@classmethod
def from_anthropic_error(cls, e: anthropic.APIError, api_provider: str):
status_code = getattr(e, "status_code", 400)
error_code = getattr(e, "error_code", "")
error_message = str(e)
# AnthropicのAPIErrorを擬似的なResponseオブジェクトに変換
pseudo_response = requests.Response()
pseudo_response.status_code = status_code
pseudo_response._content = json.dumps({"error": {"message": error_message, "code": error_code}}).encode("utf-8")
return cls.check_response(pseudo_response, api_provider)
def retry_after(self) -> Optional[int]:
if self.status_code == 429 and self.response is not None:
return int(self.response.headers.get("Retry-After", 0))
return None
def to_dict(self) -> dict[str, Any]:
return {
"message": str(self.args[0]),
"api_provider": self.api_provider,
"error_code": self.error_code,
"status_code": self.status_code,
}
class APIInterface(ABC):
@abstractmethod
def generate_caption(self, image_path: Path) -> str:
"""画像のキャプションとタグを生成。
Args:
image_path (Path): 画像のパス。
Returns:
str: 生成されたタグとキャプション。
"""
pass
@abstractmethod
def start_batch_processing(self, image_paths: list[Path], options: Optional[dict[str, Any]] = None) -> str:
"""バッチ処理を開始
Args:
image_paths (list[Path]): 画像のパスリスト。
options (Optional[dict[str, Any]]): API固有のオプション (例: Gemini の `gcs_output_uri`)。
Returns:
str: バッチ処理のIDやステータスなどを表す文字列。
"""
pass
@abstractmethod
def get_batch_results(self, batch_result: Any) -> list[dict[str, Any]]:
"""バッチ処理の結果を取得します。
Args:
batch_result (Any): start_batch_processing メソッドから返されたバッチ処理結果オブジェクト。
Returns:
list[dict[str, Any]]: 各画像の分析結果をJSON形式で格納したリスト。
"""
pass
@abstractmethod
def set_image_data(self, image_path: Path) -> None:
"""
image_dataにパスとバイナリのdictを保存する。
Args:
image_path (Path): 画像ファイルのパス
Raises:
FileNotFoundError: 指定されたパスに画像ファイルが存在しない場合
IOError: 画像ファイルの読み込み中にエラーが発生した場合
"""
pass
class BaseAPIClient(APIInterface):
"""全ての API クライアントに共通する処理を実装したベースクラス。"""
def __init__(self, prompt: str, add_prompt: str):
self.prompt = prompt
self.add_prompt = add_prompt
self.image_data: dict[str, bytes] = {} # image_data を空の辞書で初期化:
self.logger = get_logger("BaseAPIClient")
self.last_request_time = 0
self.min_request_interval = 1.0 # 1秒間隔でリクエストを制限
def _wait_for_rate_limit(self):
elapsed_time = time.time() - self.last_request_time
if elapsed_time < self.min_request_interval:
time.sleep(self.min_request_interval - elapsed_time)
def _request(self, method: str, url: str, headers: dict[str, str], data: Optional[dict[str, Any]] = None) -> str:
self._wait_for_rate_limit()
try:
response = requests.request(method, url, headers=headers, json=data, timeout=60)
self.last_request_time = time.time()
APIError.check_response(response, self.__class__.__name__)
return response.text
except requests.exceptions.RequestException as e:
raise APIError(f"リクエスト中にエラーが発生しました: {str(e)}", self.__class__.__name__)
def set_image_data(self, image_path: Path) -> None:
"""
画像データを読み込み、パスとバイナリデータの辞書に保存
Args:
image_path (Path): 画像ファイルのパス
Raises:
FileNotFoundError: 指定されたパスに画像ファイルが存在しない場合
IOError: 画像ファイルの読み込み中にエラーが発生した場合
"""
try:
with open(image_path, "rb") as image_file:
self.image_data[str(image_path)] = image_file.read()
self.logger.debug(f"画像データを正常に設定しました: {image_path}")
except FileNotFoundError:
self.logger.error(f"画像ファイルが見つかりません: {image_path}")
raise
except IOError as e:
self.logger.error(f"画像ファイルの読み込み中にエラーが発生しました: {e}")
raise
except Exception as e:
self.logger.error(f"予期せぬエラーが発生しました: {e}")
raise
class OpenAI(BaseAPIClient):
SUPPORTED_VISION_MODELS = ["gpt-4-turbo", "gpt-4o", "gpt-4o-mini"]
def __init__(self, api_key: str, prompt: str, add_prompt: str):
self.logger = get_logger("OpenAI Claude")
super().__init__(prompt, add_prompt)
self.model_name = None
self.openai_api_key = api_key
def _generate_payload(self, image_path: Path, model_name: str, prompt: str):
"""
OpenAI APIに送信するペイロードを生成する。
Args:
image_path (Path): 画像ファイルのパス
model_name (str): モデル名
prompt (str): プロンプト
Returns:
dict: APIに送信するペイロード
"""
if self.image_data is None:
raise ValueError("画像データが設定されていません。")
base64_image = base64.b64encode(self.image_data[str(image_path)]).decode("utf-8")
headers = {"Content-Type": "application/json", "Authorization": f"Bearer {self.openai_api_key}"}
payload = {
"model": model_name,
"messages": [
{
"role": "user",
"content": [
{"type": "text", "text": prompt},
{
"type": "image_url",
"image_url": {"url": f"data:image/webp;base64,{base64_image}", "detail": "high"},
},
],
}
],
"max_tokens": 3000,
}
return headers, payload
def _analyze_single_image(self, payload: dict[str, Any], headers: dict[str, str]) -> dict[str, Any]:
"""
単一画像の分析リクエストを送信
Args:
payload (dict[str, Any]): APIに送信するペイロード
headers (dict[str, str]): リクエストヘッダー
Returns:
dict[str, Any]: APIからのレスポンス
"""
self._wait_for_rate_limit()
try:
response = requests.post("https://api.openai.com/v1/chat/completions", headers=headers, json=payload, timeout=60)
self.last_request_time = time.time()
APIError.check_response(response, self.__class__.__name__)
return response.json()
except requests.exceptions.Timeout:
raise APIError("リクエストがタイムアウトしました。後でもう一度お試しください。")
except requests.exceptions.ConnectionError:
raise APIError("ネットワーク接続エラーが発生しました。インターネット接続を確認してください。")
except requests.exceptions.RequestException as e:
raise APIError(f"リクエスト中にエラーが発生しました: {str(e)}")
except json.JSONDecodeError:
raise APIError("APIレスポンスの解析に失敗しました。レスポンスが不正な形式である可能性があります。")
def generate_caption(self, image_path: Path, model_name: str) -> str:
"""
画像のキャプションを生成
Args:
image_path (Path): キャプションを生成する画像のパス。
model_name (str): モデル名デフォルトは"gpt-4o"。
prompt (str): プロンプト
Returns:
str: 生成されたキャプション。
"""
# プロンプトを作成
headers, payload = self._generate_payload(image_path, model_name, self.prompt)
# OpenAI APIにプロンプトを送信して応答を生成
response = self._analyze_single_image(payload, headers)
# 応答からキャプションを抽出
content = response["choices"][0]["message"]["content"]
return content
def create_batch_request(self, image_path: Path, model_name: str = "gpt-4o", prompt: str = "") -> dict[str, Any]:
"""
OpenAI APIに送信するバッチ処理用のペイロードを生成する。
OpenAI API のバッチ処理で使用する JSONL ファイルの各行に記述する JSON データを生成
Args:
image_path (Path): 画像ファイルのパス
model_name (str): モデル名, デフォルトは"gpt-4o"。
prompt (str): プロンプト
Returns:
dict[str, Any]: バッチリクエスト用のデータ
"""
if model_name not in self.SUPPORTED_VISION_MODELS:
raise ValueError(f"そのModelには非対応: {model_name}. Supported models: {', '.join(self.SUPPORTED_VISION_MODELS)}")
_, payload = self._generate_payload(image_path, model_name, prompt)
bach_payload = {"custom_id": image_path.stem, "method": "POST", "url": "/v1/chat/completions", "body": payload}
return bach_payload
def start_batch_processing(self, jsonl_path: Path) -> str:
"""
JSONLファイルをアップロードしてバッチ処理を開始する。
Args:
jsonl_path (Path): アップロードするJSONLファイルのパス
Returns:
str: バッチ処理のID
"""
url = "https://api.openai.com/v1/files"
headers = {"Authorization": f"Bearer {self.openai_api_key}"}
files = {"file": open(jsonl_path, "rb")}
data = {"purpose": "batch"}
try:
response = requests.post(url, headers=headers, files=files, data=data, timeout=500)
APIError.check_response(response, self.__class__.__name__)
file_id = response.json().get("id")
if file_id:
# バッチ処理を開始
url = "https://api.openai.com/v1/batches"
headers = {"Authorization": f"Bearer {self.openai_api_key}", "Content-Type": "application/json"}
data = {"input_file_id": file_id, "endpoint": "/v1/chat/completions", "completion_window": "24h"}
response = requests.post(url, headers=headers, json=data, timeout=30)
start_response = response.json()
self.logger.info(f"バッチ処理が開始されました。 ID: {start_response['id']}")
return start_response["id"]
except requests.exceptions.Timeout:
raise APIError("リクエストがタイムアウトしました。後でもう一度お試しください。")
except requests.exceptions.ConnectionError:
raise APIError("ネットワーク接続エラーが発生しました。インターネット接続を確認してください。")
except requests.exceptions.RequestException as e:
raise APIError(f"リクエスト中にエラーが発生しました: {str(e)}")
except json.JSONDecodeError:
raise APIError("APIレスポンスの解析に失敗しました。レスポンスが不正な形式である可能性があります。")
return ""
def get_batch_results(self, batch_result_dir: Path) -> dict[str, str]:
"""
OpenAI API のバッチ処理結果を読み込み、解析します。
Args:
batch_result_dir (Path): バッチ結果ファイルが格納されているディレクトリのパス。
Returns:
dict[str, str]: 画像パスをキー、分析結果を値とする辞書。
"""
results = {}
for jsonl_file in batch_result_dir.glob("*.jsonl"):
with open(jsonl_file, "r", encoding="utf-8") as f:
for line in f:
data = json.loads(line)
if "custom_id" in data and "response" in data and "body" in data["response"]:
custom_id = data["custom_id"]
content = data["response"]["body"]["choices"][0]["message"]["content"]
results[custom_id] = content
return results
class Google(BaseAPIClient):
SUPPORTED_VISION_MODELS = ["gemini-1.5-pro-exp-0801", "gemini-1.5-pro-preview-0409", "gemini-1.0-pro-vision"]
def __init__(self, api_key: str, prompt: str, add_prompt: str):
"""
Google AI Studioとのインターフェースを作成
Args:
api_key (str): Google AI StudioのAPIキー。
"""
self.logger = get_logger("Google Claude")
super().__init__(prompt, add_prompt)
self.google_api_key = api_key
self.model_name = None
# Set up the model
generation_config: dict = {
"temperature": 1,
"top_p": 0.95,
"top_k": 64,
"max_output_tokens": 8192,
}
safety_settings = [
{"category": "HARM_CATEGORY_HARASSMENT", "threshold": "BLOCK_NONE"},
{"category": "HARM_CATEGORY_HATE_SPEECH", "threshold": "BLOCK_NONE"},
{"category": "HARM_CATEGORY_SEXUALLY_EXPLICIT", "threshold": "BLOCK_NONE"},
{"category": "HARM_CATEGORY_DANGEROUS_CONTENT", "threshold": "BLOCK_NONE"},
]
genai.configure(api_key=api_key)
self.model = genai.GenerativeModel(
model_name="gemini-1.5-pro-latest",
generation_config=generation_config, # type: ignore
safety_settings=safety_settings,
)