> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Windowsでの並列処理
> MultiProcessingParams、BatchProcessor、またはアウトプロセスサーバーとしてロードされたOutprocLoaderインスタンスのプールを使用して、WindowsでABBYY FineReader Engineの並列処理を実行します。
基本的に、ABBYY FineReader Engineでマルチプロセッシングを使用する方法は3つあります。
1つ目は、[Engine](/ja/fine-reader/engine/api-reference/engine-object-iengine-interface)オブジェクトを1つ使用し、EngineオブジェクトのMultiProcessingParamsプロパティに適切な値を設定する方法です。[MultiProcessingParams](/ja/fine-reader/engine/api-reference/engine-object-iengine-interface/properties#multiprocessingparams)
ABBYY FineReader Engineは、単一のEngineインスタンスからマルチプロセッシングを提供する2種類のオブジェクトをサポートしています。[FRDocument](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument)オブジェクト ([FRDocumentオブジェクトを使用した処理](/ja/fine-reader/engine/guided-tour/advanced-techniques/parallel-processing/parallel-processing-in-windows#frdocument)を参照) と[BatchProcessor](/ja/fine-reader/engine/api-reference/batch-processor/batchprocessor)オブジェクト ([Batch Processorを使用した処理](/ja/fine-reader/engine/guided-tour/advanced-techniques/parallel-processing/parallel-processing-in-windows#batchprocessor)を参照) です。
2つ目は、COM経由でアウトプロセスサーバーとして複数のEngineインスタンスをロードし ([OutprocLoader](/ja/fine-reader/engine/api-reference/engine-loaders/outprocloader)オブジェクトを使用) 、各インスタンスをそれぞれのプロセスで使用する方法です。詳細は[Engine のプールを使用した処理](/ja/fine-reader/engine/guided-tour/advanced-techniques/parallel-processing/parallel-processing-in-windows#outprocloader)を参照してください。
並列処理は逐次処理よりも多くのRAMを必要とする点にご注意ください。ワークステーションの一般的な推奨値は350 MB \* (コア数) + 450MB RAMです。アラビア語または[CJK言語](/ja/fine-reader/engine/guided-tour/advanced-techniques/recognizing-cjk-languages#cjk)のドキュメントを処理する場合は、850 MB \* (コア数) + 750MB RAMが推奨されます。
## 使用シナリオ
ここでは、多数の文書を処理することを前提とします。ただし、必要な結果も考慮したうえで、タスクの実装に最適な方法を選ぶ必要があります。検討すべき主なシナリオは次のとおりです。
* ページ数の多い複数ページ文書を変換する場合。一般的には、書籍や長いレポートなどを処理するケースです。この場合、文書のページを並列に認識し、その後メインプロセスで合成を実行して、さらに並列でエクスポートできます。また、Engine のプールを使用している場合は、複数の複数ページ文書を同時に処理することもできますが、メモリ消費量が非常に大きくなり、"out of memory" エラーが発生することもあります。
* 1ページ文書を大量に変換する場合。請求書、契約書、レターなどを処理するケースです。このような状況では、並列処理が最も容易です。1ページ文書は相互に依存せず、一度に大量のメモリを必要としないためです。
* 大量の画像を処理し、必要な情報を検索したり、認識結果を別の方法で利用したりする場合。これらの大半は編集可能な形式に変換する必要がない可能性があるため、合成やエクスポートの速度は問題になりません。複数のプロセスで実行される操作は、レイアウトブロックを順に処理し、テキストブロックの認識結果にアクセスすることです。
エクスポートで並列処理を使用する場合は、この機能がサポートされているのは PDF へのエクスポート (TextOnly モードを除く) と PPTX 形式のみであることに注意してください。
## 推奨事項と制限事項
* 多ページ文書の並列処理を行う場合、FRDocument の使用をおすすめします。追加のインターフェイスを実装する必要がないため、コーディングが最も簡単なマルチプロセッシング手法です。
開く、前処理、分析、認識は並列で実行されます。文書合成はメイン プロセスで順次実行され、その後、PDF および PPTX 形式へのエクスポート (TextOnly モードを除く) が並列で実行されます。
* スキャナーなどのソースから受信される多数の 1 ページ文書を処理する場合、BatchProcessor の使用をおすすめします。
この手法の利点は、文書の数を事前に知らない場合、文書が異なる種類の場合、または到着次第すぐに処理する必要がある場合に使用できる点です。欠点は、実装に追加の労力が必要な点で、ファイル アダプターとカスタム画像ソース用のインターフェイスを実装しなければなりません。
すべての処理ステージは並列で実行されます。1 ページ文書の場合、ページごとおよび文書合成が個別に実行されるためです。
Batch Processor を使用したシナリオでは、並列エクスポートはサポートされていません。
* 多数の 1 ページ文書を並列でフル処理するには、COM を使用してアウトプロセスで読み込まれた Engine のプールを使用できます。この手法は速度面で最も効率的であり、マルチスレッド関連のすべての問題を自動的に解消します。ABBYY FineReader Engine オブジェクトのすべての操作が COM を介して直列化されるためです。ただし、いくつかの制限があります：
* COM の使用により、FREngine.dll を登録する必要があります。
* コードが C++ で記述されている場合、COM との操作は、たとえば C# に比べてより多くの煩雑なコーディングを必要とします。
* この場合、処理は別のプロセスで実行されるため、メモリから画像を開くことができず、認識結果のイテレーションに時間がかかります。各リクエストが別のプロセスに渡され、戻されるためです。
* 最後に、いくつかの Engine インスタンスを読み込むことは、より多くのメモリ消費を意味します。特に、この場合すべての処理ステージが並列で実行され、いくつかの同時合成操作が同時に進行し、さらにメモリを使用するためです。
* 並列処理中に発生したイベントをキャッチして処理するには、[IParallelProcessingCallback](/ja/fine-reader/engine/api-reference/supplementary-objects-and-methods/iparallelprocessingcallback) インターフェイスを使用できます。このインターフェイスは、問題が発生した状況を管理するのに非常に役立ちます。たとえば、タイムアウト エラーが発生した場合、[IParallelProcessingCallback](/ja/fine-reader/engine/api-reference/supplementary-objects-and-methods/iparallelprocessingcallback) インターフェイスは、ユーザー設定に応じて問題に対するいくつかの解決策を提供します。詳細については、[IParallelProcessingCallback::OnWaitIntervalExceeded](/ja/fine-reader/engine/api-reference/supplementary-objects-and-methods/iparallelprocessingcallback/onwaitintervalexceeded-method) を参照してください。
ページの並列処理中に発生したイベントは、全体の文書のイベントに変換されます。
## 速度テストの結果
以下の表にパフォーマンステストの結果を示します。
| | 1ページ文書 | 1つの複数ページ文書 | エクスポートなしでの結果検索 |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ---------- | -------------- |
| 逐次処理 | 60 | 51 | 87 |
| FRDocument を使用した処理 | 41 | 117 | 57 |
| FRDocument を使用した処理 (with [PageFlushingPolicy](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument#pageflushingpolicy) = PFP\_KeepInMemory) | 55 | 141 | 82 |
| Batch Processor を使用した処理 | 99 | 115 | 294 |
| Engine のプールを使用した処理 | 165 | 10 | 102 |
テストマシンのプロセッサは Intel® Core™ i5-4440 (3.10 GHz、4 物理コア)、RAM は 8 GB で、同時に実行されるプロセスの数は 4 です。パフォーマンスは、[DocumentArchiving\_Speed](/ja/fine-reader/engine/guided-tour/advanced-techniques/working-with-profiles#documentarchiving_speed) プリ定義プロファイルの設定を使用して、300 枚の英語画像でテストされました。表の数値は 1 分間に処理されたページ数です。「1 ページ文書」および「1 つの複数ページ文書」のシナリオでは、文書を PDF 形式にエクスポートします。
## FRDocument オブジェクトを使用した処理
実行するプロセス数は、使用可能な物理または論理 CPU コア数、ライセンスで利用可能な空き CPU コア数、およびドキュメントのページ数に基づいて自動的に決定されます。マルチプロセッシングモードを有効にするには、次の手順を実行します。
1. [Engine](/ja/fine-reader/engine/api-reference/engine-object-iengine-interface/properties#multiprocessingparams) オブジェクトの [MultiProcessingParams](/ja/fine-reader/engine/api-reference/parameter-objects/multiprocessingparams) サブオブジェクトの MultiProcessingMode プロパティの値を設定します。このプロパティが MPM\_Parallel または MPM\_Auto に設定されており、ドキュメントのページ数と使用可能な CPU コア数がいずれも 1 より大きい場合、並列処理が使用されます。
2. RecognitionProcessesCount プロパティを使用して実行するプロセス数を調整し、必要に応じてその他のプロパティの値を指定します。
マルチプロセッシングの設定が完了したら、[FRDocument](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument) を使用した標準的な作業手順を利用できます。ABBYY FineReader Engine は、FRDocument オブジェクトの以下のメソッドのいずれかを呼び出すと、複数の認識プロセスを自動的に開始します。
* [AddImageFile](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument/addimagefile-method)、[AddImageFileFromMemory](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument/addimagefilefrommemory-method)、[AddImageFileFromStream](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument/addimagefilefromstream-method)、[AddImageFileWithPassword](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument/addimagefilewithpassword-method)、[AddImageFileWithPasswordCallback](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument/addimagefilewithpasswordcallback-method)
* [Preprocess](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument/preprocess-method)、[PreprocessPages](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument/preprocesspages-method)
* [Analyze](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument/analyze-method)、[AnalyzePages](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument/analyzepages-method)
* [Recognize](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument/recognize-method)、[RecognizePages](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument/recognizepages-method)
* [Process](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument/process-method)、[ProcessPages](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument/processpages-method)
* [Export](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument/export-method)、[ExportPages](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument/exportpages-method)、[ExportToMemory](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument/exporttomemory-method) — PDF (TextOnly モードを除く) および PPTX 形式へのエクスポートのみ対象
ドキュメントの各ページに対して新しい処理タスクが作成され、そのタスクはいずれかの認識プロセスに渡されます。認識プロセスがタスクを完了すると、次の処理タスクを受け取ります。これはすべてのタスクが処理されるまで繰り返されます。
```csharp theme={null}
// ドキュメントを作成する
FREngine.IFRDocument document = engine.CreateFRDocument();
// ドキュメントにページを追加する
for( int index = 0; index < filesNumber; index++ ) {
string imagePath = filePaths[index];
document.AddImageFile( imagePath, null, null );
}
// マルチプロセッシングパラメーターを設定する
engine.MultiProcessingParams.MultiProcessingMode = FREngine.MultiProcessingModeEnum.MPM_Parallel;
engine.MultiProcessingParams.RecognitionProcessesCount = coresNumber;
// ドキュメント処理パラメーターを作成して設定する
FREngine.IDocumentProcessingParams documentProcessingParams = engine.CreateDocumentProcessingParams();
...
// ドキュメントを処理する
document.Process( documentProcessingParams );
// 通常どおりドキュメントを合成してエクスポートし、結果を処理するなど
...
```
ABBYY FineReader Engine の配布パッケージには、[MultiProcessingRecognition](/ja/fine-reader/engine/guided-tour/samples#multiprocessingrecognition) デモツールが含まれています。このツールは、FRDocument オブジェクトを使用したマルチプロセッシング認識による速度向上を実証するものであり、独自のアプリケーション開発を始める際に活用できる実装例が含まれています。
## Batch Processorを使用した処理
Batch Processorが初期化されると、非同期認識プロセスが起動・設定されます。その後、プロセッサはカスタム画像ソースから画像ファイルを取得します。画像ファイルの各ページに対して新しい処理タスクが作成され、そのタスクはいずれかの認識プロセスに渡されます。1つのファイルのすべてのタスクが処理のために渡されたにもかかわらず、すべての認識プロセスが使用中でない場合、ソースの画像キューから次の画像ファイルが取得され、処理に渡されます。この処理は、最初の画像ページが変換されてユーザーに渡されるまで繰り返されます。ページは画像ソースから取得された順序でユーザーに返されます。
Batch Processorを使用してマルチプロセッシングを構成するには、以下の手順に従います。
1. 画像ソースおよびその中のファイルへのアクセスを提供する [IImageSource](/ja/fine-reader/engine/api-reference/batch-processor/iimagesource) インターフェイスと [IFileAdapter](/ja/fine-reader/engine/api-reference/batch-processor/ifileadapter) インターフェイスを実装します。
2. \[省略可能] 処理を管理するために [IAsyncProcessingCallback](/ja/fine-reader/engine/api-reference/batch-processor/iasyncprocessingcallback) インターフェイスを実装します。このインターフェイスのメソッドを使用すると、エラーの処理や処理のキャンセルが可能です。
3. \[省略可能] [Engine](/ja/fine-reader/engine/api-reference/engine-object-iengine-interface/properties#multiprocessingparams) オブジェクトの [MultiProcessingParams](/ja/fine-reader/engine/api-reference/parameter-objects/multiprocessingparams) サブオブジェクトを使用してマルチプロセッシングを設定します。Batch Processorを使用する場合はデフォルトで並列処理が使用されるため、MultiProcessingModeプロパティを設定する必要はありません。RecognitionProcessesCountプロパティで実行するプロセス数を調整し、必要に応じてその他のプロパティの値を指定します。
4. Engine オブジェクトの [CreateBatchProcessor](/ja/fine-reader/engine/api-reference/engine-object-iengine-interface/creation-methods/createlessobjectgreater-methods) メソッドを呼び出して、BatchProcessorオブジェクトを取得します。
5. このオブジェクトの [Start](/ja/fine-reader/engine/api-reference/batch-processor/batchprocessor/start-method) メソッドを呼び出して、プロセッサを初期化し、非同期認識プロセスを起動します。このメソッドの呼び出し時に、画像のソースを指定し、IAsyncProcessingCallbackインターフェイスおよびParameterオブジェクトへの参照を渡すことができます。
6. GetNextProcessedPageメソッドをループ内で呼び出し続け、メソッドが0を返した時点で終了します。0が返された場合は、ソースに画像がなくなり、処理済みのすべての画像がユーザーに返されたことを意味します。
GetNextProcessedPageメソッドが返すページは、このメソッドの次の呼び出しまでのみ有効です。そのため、このページを保存する場合は、GetNextProcessedPageメソッドを次に呼び出す前に、[FRPage](/ja/fine-reader/engine/api-reference/document-related-objects/frpage) オブジェクトのメソッドを使用して保存するか、[IFRDocument::AddPage](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument/addpage-method) メソッドを使用して既存のドキュメントに追加する必要があります。
```csharp theme={null}
// Batch Processorを作成する
FREngine.IBatchProcessor batchProcessor = engine.CreateBatchProcessor();
// マルチプロセッシングパラメータを設定する
engine.MultiProcessingParams.RecognitionProcessesCount = coresNumber;
// プロセッサを初期化する
FREngine.IImageSource imageSource = new CImageSource; // このクラスはユーザーが実装する
batchProcessor.Start( imageSource, null, null, null );
// 処理を開始する
while( true ) {
FREngine.IFRPage page = batchProcessor.GetNextProcessedPage();
if( page == null ) {
break; // ページがなくなったため、処理を終了する
}
// ページに対して何らかの処理を行う
page.Synthesize( null );
page.Export("D:\\sample.pdf", FREngine.FileExportFormatEnum.FEF_PDF, null);
}
```
ABBYY FineReader Engine の配布パッケージには、Batch Processorの使用方法を示す [BatchProcessing](/ja/fine-reader/engine/guided-tour/samples#batchprocessing) サンプルと、Batch Processorを使用したマルチプロセッシング認識による速度向上を示す [BatchProcessingRecognition](/ja/fine-reader/engine/guided-tour/samples#batchprocessingrecognition) デモツールが含まれています。
## Engineのプールを使用した処理
このマルチプロセッシングシナリオでは、アウトプロセスで読み込まれた複数のEngineインスタンスを使用します。各ワーカースレッド内の手順は、単一スレッドの処理とほぼ同じです。ただし、各画像が必ず一度だけ処理されるよう、何らかの同期オブジェクトを使用してスレッド間で画像を分配するカスタム画像ソースを実装することを推奨します。
[Engine](/ja/fine-reader/engine/api-reference/engine-object-iengine-interface)オブジェクトをアウトプロセスで読み込むには、[IEngineLoader](/ja/fine-reader/engine/api-reference/engine-loaders/iengineloader)インターフェイスを実装する[OutprocLoader](/ja/fine-reader/engine/api-reference/engine-loaders/outprocloader)オブジェクトを使用します。特別なアカウントで使用する場合、そのアカウントでOutprocLoaderを実行するために権限が必要になる場合があります。
```csharp theme={null}
// スレッドごとに個別のOutprocLoaderオブジェクトを作成し、Engineのインスタンスを読み込む
IEngineLoader engineLoader = new FREngine.OutprocLoader();
IEngine engine = engineLoader.InitializeEngine( customerProjectId, LicensePath, LicensePassword, "", "", false );
// 別プロセスでEngineを取得した
try {
...
} finally {
engineLoader.ExplicitlyUnload(); // 不要になったらアンロードできる
engineLoader = null;
GC.Collect();
GC.WaitForPendingFinalizers();
}
```
また、[IHostProcessControl](/ja/fine-reader/engine/api-reference/engine-loaders/ihostprocesscontrol)インターフェイスを使用して、ホストプロセスの優先度の管理や、プロセスの稼働状態の確認を行うことができます。
* アカウントの権限は、DCOM Config ユーティリティを使用して設定できます (コマンドラインで「DCOMCNFG」と入力するか、コントロールパネル > 管理ツール > コンポーネントサービスを選択します) 。コンソールツリーで、コンポーネントサービス > コンピューター > マイコンピューター > DCOM Config フォルダーを開き、ABBYY FineReader Engine 12.5 Loader (ローカルサーバー) を右クリックして「プロパティ」をクリックします。ダイアログが開きます。「セキュリティ」タブをクリックし、「起動とアクティブ化のアクセス許可」の「カスタマイズ」をクリックしてから「編集」をクリックして、アプリケーションを起動できるアカウントを指定します。
64ビットオペレーティングシステムでは、登録されたDCOMアプリケーションは32ビットのMMCコンソールで利用可能です。このコンソールは、次のコマンドラインで起動できます。
```
"mmc comexp.msc /32"
```
* エンドユーザーのコンピューターにアプリケーションをインストールする際に `FREngine.dll` を登録するには、`regsvr32` ユーティリティを使用します。64 ビット オペレーティング システムでは、既定で 64 ビット版の `regsvr32` が実行されます。次のコマンドラインを使用します。
```csharp theme={null}
regsvr32 /s /n /i:"" ""
```
* Engine をアウトプロセスサーバーとして実装する場合は、[MultiProcessingParams](/ja/fine-reader/engine/api-reference/parameter-objects/multiprocessingparams) オブジェクトの MultiProcessingMode プロパティを MPM\_Sequential に設定して、ドキュメント処理のシーケンシャルモードを指定してください。
ABBYY FineReader Engine の配布パッケージには [EnginesPool](/ja/fine-reader/engine/guided-tour/samples#enginespool) サンプルが含まれています。このサンプルでは、Engine のプールを使用した際の処理速度の向上を確認できるほか、独自アプリケーションの出発点として活用できる実装も提供しています。カスタム画像ソースの実装、例外処理、CPU コア使用量の制御については、このサンプルのソースコードを参照してください。
## 関連項目
[FRDocument](/ja/fine-reader/engine/api-reference/document-related-objects/frdocument)
[BatchProcessor](/ja/fine-reader/engine/api-reference/batch-processor/batchprocessor)
[MultiProcessingParams](/ja/fine-reader/engine/api-reference/parameter-objects/multiprocessingparams)
[ドキュメントページの反復処理](/ja/fine-reader/engine/guided-tour/advanced-techniques/iterating-document-pages)
[Engine オブジェクトのさまざまな読み込み方法](/ja/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/different-ways-to-load-engine)
[マルチスレッドサーバーアプリケーションでの ABBYY FineReader Engine の使用](/ja/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/using-in-server-applications)