Skip to content

Commit

Permalink
chore: Fix spelling (#459)
Browse files Browse the repository at this point in the history
Fixes misspellings identified by the [check-spelling
action](https://github.com/marketplace/actions/check-spelling).

The misspellings have been reported at
https://github.com/jsoref/unstructured-api/actions/runs/10822287753#summary-30025895524

The action will report that the changes in this PR would make it happy:
https://github.com/jsoref/unstructured-api/actions/runs/10822287924#summary-30025895935

---------

Signed-off-by: Josh Soref <[email protected]>
  • Loading branch information
jsoref authored Sep 12, 2024
1 parent 456bb9b commit 2a0f3b7
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 12 deletions.
6 changes: 3 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@
## 0.0.56
* **Add `max_characters` param for chunking** This param gives users additional control to "chunk" elements into larger or smaller `CompositeElement`s
* Bump unstructured to 0.10.28
* Make sure chipperv2 is called whien `hi_res_model_name==chipper`
* Make sure chipperv2 is called when `hi_res_model_name==chipper`


## 0.0.55
Expand Down Expand Up @@ -164,7 +164,7 @@

## 0.0.48

* **Adds `languages` kwarg** `ocr_languages` will eventually be deprecated and replaced by `lanugages` to specify what languages to use for OCR
* **Adds `languages` kwarg** `ocr_languages` will eventually be deprecated and replaced by `languages` to specify what languages to use for OCR
* Adds a startup log and other minor cleanups

## 0.0.47
Expand Down Expand Up @@ -215,7 +215,7 @@

## 0.0.39

* Fix wrong handleing on param skip_infer_table_types
* Fix incorrect handling on param skip_infer_table_types
* Pin `safetensors` to fix a build error with 0.0.38

## 0.0.38
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ By default server will run for indefinitely. To change that the `MAX_LIFETIME_SE

After the graceful period is over if server is still running, it is shutdown forcefully, cancelling all active requests and sending empty responses to each of them.

*Max lifetime requires gnu [timeout](https://www.gnu.org/software/coreutils/manual/html_node/timeout-invocation.html#timeout-invocation) to be installed, available by default on most linux systems. Downloadable on MacOS as gtimeout with gnu coreutils.*
*Max lifetime requires gnu [timeout](https://www.gnu.org/software/coreutils/manual/html_node/timeout-invocation.html#timeout-invocation) to be installed, available by default on most linux systems. Downloadable on macOS as gtimeout with gnu coreutils.*

## :dizzy: Instructions for using the Docker image

Expand Down Expand Up @@ -425,8 +425,8 @@ information on how to report security vulnerabilities.

| Section | Description |
|-|-|
| [Unstructured Community Github](https://github.com/Unstructured-IO/community) | Information about Unstructured.io community projects |
| [Unstructured Github](https://github.com/Unstructured-IO) | Unstructured.io open source repositories |
| [Unstructured Community GitHub](https://github.com/Unstructured-IO/community) | Information about Unstructured.io community projects |
| [Unstructured GitHub](https://github.com/Unstructured-IO) | Unstructured.io open source repositories |
| [Company Website](https://unstructured.io) | Unstructured.io product and company info |

## :chart_with_upwards_trend: Analytics
Expand Down
4 changes: 2 additions & 2 deletions prepline_general/api/general.py
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ def partition_file_via_api(
The remote url is set by the `UNSTRUCTURED_PARALLEL_MODE_URL` environment variable.
Args:
`file_tuple` is a file-like object and byte offset of a page (file, page_offest)
`file_tuple` is a file-like object and byte offset of a page (file, page_offset)
`request` is used to forward the api key header
`filename` and `content_type` are passed in the file form data
`partition_kwargs` holds any form parameters to be sent on
Expand Down Expand Up @@ -674,7 +674,7 @@ def general_partition(
# cannot use annotated type here because of a bug described here:
# https://github.com/tiangolo/fastapi/discussions/10280
# The openapi metadata must be added separately in openapi.py file.
# TODO: Check if the bug is fixed and change the declaration to use Annoteted[List[UploadFile], File(...)]
# TODO: Check if the bug is fixed and change the declaration to use Annotated[List[UploadFile], File(...)]
# For new parameters - add them in models/form_params.py
files: List[UploadFile],
form_params: GeneralFormParams = Depends(GeneralFormParams.as_form),
Expand Down
4 changes: 2 additions & 2 deletions prepline_general/api/openapi.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,10 @@ def _apply_customizations(openapi_schema: dict[str, Any]) -> None:
}
}

# TODO: Instead of a list of paramaters, crete a PartitionParameters model
# TODO: Instead of a list of parameters, crete a PartitionParameters model
# and declare schema keys (type, format, description) as attributes
# https://fastapi.tiangolo.com/reference/openapi/models/?h=model
# Update the schema key from `Body_partition` to `partition_paramaters`
# Update the schema key from `Body_partition` to `partition_parameters`

# TODO: Similarly, create an Element model
# https://fastapi.tiangolo.com/reference/openapi/models/?h=model
Expand Down
2 changes: 1 addition & 1 deletion requirements/base.in
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ click==8.1.3
# NOTE(robinson) - fastapi>=0.114.0 causes the test listed below to fail, though it
# works if data if chunking strategy and new_after_n_chars are explicitly set. Pinning
# for now to preserve behavior
# test_parallel_mode_preserves_uniqueness_of_hashes_when_asssembling_page_splits
# test_parallel_mode_preserves_uniqueness_of_hashes_when_assembling_page_splits
fastapi<0.114.0
uvicorn
ratelimit
Expand Down
2 changes: 1 addition & 1 deletion test_general/api/test_app.py
Original file line number Diff line number Diff line change
Expand Up @@ -874,7 +874,7 @@ def test_chunking_strategy_param():


# Defaults:
# multippage = True, combine_text_under_n_chars = None, new_after_n_chars = None,
# multipage = True, combine_text_under_n_chars = None, new_after_n_chars = None,
# max_characters = 500
@pytest.mark.parametrize(
("multipage_sections", "combine_under_n_chars", "new_after_n_chars", "max_characters"),
Expand Down

0 comments on commit 2a0f3b7

Please sign in to comment.