Skip to content

Commit d0a7f9c

Browse files
authored
Update readme note on minimum free memory check (#367)
Update the wording to: * Clarify that this is an environment variable * Explain how server behavior changes when the value is changed
1 parent 7089db0 commit d0a7f9c

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ As mentioned above, processing a pdf using `hi_res` is currently a slow operatio
345345
You may also set the optional `UNSTRUCTURED_API_KEY` env variable to enable request validation for your self-hosted instance of Unstructured. If set, only requests including an `unstructured-api-key` header with the same value will be fulfilled. Otherwise, the server will return a 401 indicating that the request is unauthorized.
346346

347347
#### Controlling Server Load
348-
Some documents will use a lot of memory as they're being processed. To mitigate OOM errors, the server will return a 503 if the host's available memory drops below 2GB. This is configurable with `UNSTRUCTURED_MEMORY_FREE_MINIMUM_MB`.
348+
Some documents will use a lot of memory as they're being processed. To mitigate OOM errors, the server will return a 503 if the host's available memory drops below 2GB. This is configured with the environment variable `UNSTRUCTURED_MEMORY_FREE_MINIMUM_MB`, which defaults to 2048. You can lower this value to reduce these messages, that is, allow the server to use more memory. Otherwise, you can set to 0 to fully remove this check.
349349

350350
## :dizzy: Instructions for using the Docker image
351351

0 commit comments

Comments
 (0)