Skip to content

Commit 27a107f

Browse files
committed
📝 harmonize samples with other SDKs
1 parent e4e018e commit 27a107f

5 files changed

Lines changed: 30 additions & 30 deletions

File tree

docs/extras/code_samples/v2_classification.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
from mindee import PathInput
22
from mindee.v2 import (
3-
Client,
4-
ClassificationParameters,
5-
ClassificationResponse,
3+
Client,
4+
ClassificationParameters,
5+
ClassificationResponse,
66
)
77

88
input_path = "/path/to/the/file.ext"
@@ -12,8 +12,8 @@ model_id = "MY_MODEL_ID"
1212
# Init a new client
1313
mindee_client = Client(api_key)
1414

15-
# Set parameters
16-
params = ClassificationParameters(
15+
# Set Classification parameters
16+
model_params = ClassificationParameters(
1717
# ID of the model, required.
1818
model_id=model_id,
1919
)
@@ -25,7 +25,7 @@ input_source = PathInput(input_path)
2525
response = mindee_client.enqueue_and_get_result(
2626
ClassificationResponse,
2727
input_source,
28-
params,
28+
model_params,
2929
)
3030

3131
# Print a brief summary of the parsed data

docs/extras/code_samples/v2_crop.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
from mindee import PathInput
22
from mindee.v2 import (
3-
Client,
4-
CropParameters,
5-
CropResponse,
3+
Client,
4+
CropParameters,
5+
CropResponse,
66
)
77

88
input_path = "/path/to/the/file.ext"
@@ -12,8 +12,8 @@ model_id = "MY_MODEL_ID"
1212
# Init a new client
1313
mindee_client = Client(api_key)
1414

15-
# Set parameters
16-
params = CropParameters(
15+
# Set Crop parameters
16+
model_params = CropParameters(
1717
# ID of the model, required.
1818
model_id=model_id,
1919
)
@@ -25,7 +25,7 @@ input_source = PathInput(input_path)
2525
response = mindee_client.enqueue_and_get_result(
2626
CropResponse,
2727
input_source,
28-
params,
28+
model_params,
2929
)
3030

3131
# Print a brief summary of the parsed data

docs/extras/code_samples/v2_extraction.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
from mindee import PathInput
22
from mindee.v2 import (
3-
Client,
4-
ExtractionParameters,
5-
ExtractionResponse,
3+
Client,
4+
ExtractionParameters,
5+
ExtractionResponse,
66
)
77

88
input_path = "/path/to/the/file.ext"
@@ -12,8 +12,8 @@ model_id = "MY_MODEL_ID"
1212
# Init a new client
1313
mindee_client = Client(api_key)
1414

15-
# Set extraction parameters
16-
params = ExtractionParameters(
15+
# Set Extraction parameters
16+
model_params = ExtractionParameters(
1717
# ID of the model, required.
1818
model_id=model_id,
1919

@@ -37,7 +37,7 @@ input_source = PathInput(input_path)
3737
response = mindee_client.enqueue_and_get_result(
3838
ExtractionResponse,
3939
input_source,
40-
params,
40+
model_params,
4141
)
4242

4343
# Print a brief summary of the parsed data

docs/extras/code_samples/v2_ocr.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
from mindee import PathInput
22
from mindee.v2 import (
3-
Client,
4-
OCRParameters,
5-
OCRResponse,
3+
Client,
4+
OCRParameters,
5+
OCRResponse,
66
)
77

88
input_path = "/path/to/the/file.ext"
@@ -12,8 +12,8 @@ model_id = "MY_MODEL_ID"
1212
# Init a new client
1313
mindee_client = Client(api_key)
1414

15-
# Set parameters
16-
params = OCRParameters(
15+
# Set Raw OCR parameters
16+
model_params = OCRParameters(
1717
# ID of the model, required.
1818
model_id=model_id,
1919
)
@@ -25,7 +25,7 @@ input_source = PathInput(input_path)
2525
response = mindee_client.enqueue_and_get_result(
2626
OCRResponse,
2727
input_source,
28-
params,
28+
model_params,
2929
)
3030

3131
# Print a brief summary of the parsed data

docs/extras/code_samples/v2_split.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
from mindee import PathInput
22
from mindee.v2 import (
3-
Client,
4-
SplitParameters,
5-
SplitResponse,
3+
Client,
4+
SplitParameters,
5+
SplitResponse,
66
)
77

88
input_path = "/path/to/the/file.ext"
@@ -12,8 +12,8 @@ model_id = "MY_MODEL_ID"
1212
# Init a new client
1313
mindee_client = Client(api_key)
1414

15-
# Set parameters
16-
params = SplitParameters(
15+
# Set Split parameters
16+
model_params = SplitParameters(
1717
# ID of the model, required.
1818
model_id=model_id,
1919
)
@@ -25,7 +25,7 @@ input_source = PathInput(input_path)
2525
response = mindee_client.enqueue_and_get_result(
2626
SplitResponse,
2727
input_source,
28-
params,
28+
model_params,
2929
)
3030

3131
# Print a brief summary of the parsed data

0 commit comments

Comments
 (0)