You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Projects/Nitrodigest/Docs/Getting Started/Quickstart.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ You can also run NitroDigest without any arguments to process all supported file
23
23
nitrodigest
24
24
```
25
25
26
-
This will automatically find and summarize all text files (`.txt`, `.md`, `.html`, `.json`, `.csv`, `.log`, etc.) in the current working directory.
26
+
This will automatically find and summarize all text files (`.txt`, `.md`, `.html`, `.json`, `.csv`, `.log`, etc.) in the current working directory. NitroDigest processes multiple files in parallel (up to 4 simultaneously by default) and shows a progress bar during processing.
Directory processing complete: 4 of 4 files processed successfully
104
+
---
105
+
106
+
<summary of project-report.md>
98
107
```
99
108
100
109
### Save All Summaries to One File
@@ -149,12 +158,33 @@ project/
149
158
150
159
All three files (`overview.md`, `specifications.txt`, and `notes.txt`) will be processed.
151
160
152
-
### File Ordering
161
+
### Parallel Processing
153
162
154
-
Files are processed in the order they're discovered by the file system, which typically means:
163
+
NitroDigest processes multiple files simultaneously to improve performance. By default, it uses 4 parallel workers, meaning up to 4 files can be processed at the same time.
155
164
156
-
- Files in the main directory first
157
-
- Then files in subdirectories
165
+
#### Adjusting Parallel Workers
166
+
167
+
You can control the number of parallel workers based on your system resources and needs:
168
+
169
+
```bash
170
+
# Use 8 workers for faster processing (good for powerful systems)
171
+
nitrodigest documents/ --max-workers 8
172
+
173
+
# Use 2 workers for slower systems or to reduce resource usage
174
+
nitrodigest documents/ --max-workers 2
175
+
176
+
# Use 1 worker for sequential processing
177
+
nitrodigest documents/ --max-workers 1
178
+
```
179
+
180
+
**When to adjust workers:**
181
+
-**Increase workers (6-8):** If you have a powerful system and want maximum speed
182
+
-**Decrease workers (1-2):** If you have limited RAM, CPU, or want to reduce system load
183
+
-**Keep default (4):** For most use cases, this provides a good balance
184
+
185
+
### File Ordering
186
+
187
+
Files are processed in parallel, so they may complete in a different order than discovered. However, all files in the directory and subdirectories will be processed.
# Monitor your system resources (CPU, RAM) and adjust workers accordingly
234
+
# If Ollama is running on the same machine, consider your model's resource needs
235
+
```
236
+
237
+
**Pro tip:** The optimal number of workers depends on your Ollama setup. If Ollama is using significant resources, fewer workers may actually be faster.
238
+
195
239
### Organize Your Input
196
240
197
241
Structure your directories logically before processing:
@@ -253,6 +297,18 @@ If your directory contains specialized content, use a custom prompt:
253
297
nitrodigest technical_docs/ --prompt "Summarize this technical document focusing on implementation details and requirements"> tech_summaries.md
254
298
```
255
299
300
+
### Combining Parallel Processing with Other Options
301
+
302
+
You can combine `--max-workers` with other options for optimized processing:
-**Local AI Summarization:** Uses Ollama to run LLMs on your machine, preserving privacy and working offline.
11
11
-**Multiple Input Formats:** Supports plain text, Markdown, HTML, CSV, JSON, and other text-based files.
12
12
-**Multiple Output Formats: By default NitroDigest returns Text, but for advanced processing it can return JSON.
13
-
-**Batch Processing:** Summarize a single file or all files in a directory in one command.
13
+
-**Parallel Batch Processing:** Summarize a single file or process multiple files in a directory simultaneously with configurable parallel workers for faster processing.
14
14
-**Configurable Prompts:** Uses prompt templates that you can customize to change the style or content of summaries.
15
15
-**Extensible:** Easily switch to different models (e.g., use a larger or domain-specific Ollama model) and adjust token budgets or segmentation for large inputs.
0 commit comments