Add new endpoints for workflows and prepare for future deprecation #336

PawelPeczek-Roboflow · 2024-03-27T13:22:16Z

Description

There were couple of changes in this PR:

Changes in workflows endpoints

Adjusted sdk client to changes

Maintained backward compatibility of endpoints

old endpoints are still alive, sunset day is set in docs
there is deprecation warning on old methods
API docs also contain deprecation warning

Provided self-descriptive capabilities for `workflows` blocks and endpoints to describe all loaded steps

introduced notion of reference kinds - which is simple type-system on referred values
without detailed knowledge of steps, just based on definitions we can do multiple things:
- deduce which step can be connected to which other:
- it is possible to prepare generic entities builder

Provided endpoint to validate `workflows` JSON definitions

Improved significantly `workflows` syntax validation by establishing typedefs with constraint checks in `pydantic`

OLD:

NEW:

Thanks to that: ➖ 900 lines of code

Registered workflows in `InferencePipeline`

Fixed couple of bugs

YoloWorld in workflows at hosted platform
wrong definition of detection filter filtering claims

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
This change requires a documentation update

How has this change been tested, please provide a testcase or example of how you tested the change?

CI still 🟢 - most importantly our validators for syntax and semantic of workflows - which means that we shall not expect breaking change in that
new tests added for new functionality
deployed and tested @ staging (with load tests and tests of new functionalities executed)

Any specific deployment considerations

tested at staging, postponing PROD deployment to next week due to holidays
should not be breaking in terms of workflows contract

Docs

Docs updated? What were the changes: workflows, InferencePipeline inference_sdk

…precation of new parameter later on

yeldarby

Only got partway through reviewing but have to go into meetings for a bit. Will finish later but wanted to get these comments out there.

inference/core/interfaces/stream/inference_pipeline.py

inference/enterprise/workflows/complier/introspection.py

inference/enterprise/workflows/entities/steps.py

yeldarby · 2024-04-02T13:58:39Z

inference/enterprise/workflows/entities/steps.py

+ description="Parameter to decide if Active Learning data sampling is disabled for the model",
+ examples=[True, "$inputs.disable_active_learning"],
+ )
+ active_learning_target_dataset: Union[


Would be useful to add an array of tag strings that get added to the uploaded images.

would be, but this is also possible in AL config that can be declared in-place. We can add this feature, but I would put that into to-do for next iteration

this is also possible in AL config that can be declared in-place

Can you clarify? I don't think I understand what this is

I would put that into to-do for next iteration

Sounds good

this is also possible in AL config that can be declared in-place -> you can request specific tags to be added via config of AL that can be defined either at project level or in-place

yeldarby · 2024-04-02T14:04:01Z

inference/enterprise/workflows/entities/steps.py

@@ -432,31 +511,44 @@ def validate_field_binding(self, field_name: str, value: Any) -> None:


 class InstanceSegmentationModel(ObjectDetectionModel):


Is there an easy way to know from the manifest whether something is a subclass of BaseModel? I think right now I just check if the name ends in _model

do you mean BaseModel or RoboflowModel.
If the former - each manifest class must be derived after pydantic.BaseModel
If the latter - no way now - I feel like additional metadata about steps can be held in

model_config = ConfigDict( json_schema_extra={ "description": "This block represents inference from Roboflow multi-class classification model.", "docs": "https://inference.roboflow.com/workflows/classify_objects", <- additional keys here } )

Is that in the manifest? I don't see BaseModel or base_model in there anywhere.

no it is not, that's just required for pydantic to work

inference/enterprise/workflows/entities/steps.py

yeldarby · 2024-04-02T14:11:19Z

inference/enterprise/workflows/entities/steps.py

@@ -676,15 +855,26 @@ def validate_field_binding(self, field_name: str, value: Any) -> None:


 class BarcodeDetection(BaseModel, StepInterface):


Should we rename this BarcodeModel since it inherits from BaseModel? (At the least should be BarcodeDetector vs Detection to match the part of speech of other blocks)

that's pydantic.BaseModel.
BarcodeDetector is fine, we would also need to change QRCodeDetection in the same way

ok, changed.
Also made the change non-breaking by double-aliasing step type - we will sun-set old ones in some time

Also wonder if eg YoloWorld should be called YoloWorldModel

inference/enterprise/workflows/entities/steps.py

PawelPeczek-Roboflow · 2024-04-02T21:44:23Z

I am branching out from this ref. point to re-structure the workflows steps - I propose to only fix issues in this PR, additional feature requests I will implement later

yeldarby

Read through the rest & looks good!

yeldarby · 2024-04-02T23:46:06Z

inference/enterprise/workflows/entities/steps.py

@@ -432,31 +511,44 @@ def validate_field_binding(self, field_name: str, value: Any) -> None:


 class InstanceSegmentationModel(ObjectDetectionModel):


Is that in the manifest? I don't see BaseModel or base_model in there anywhere.

PawelPeczek-Roboflow added 19 commits March 27, 2024 14:20

Add new endpoints for workflows and prepare for future deprecation

8fd4580

Make linter happy

d02756e

Tweak SDK client implementation such that there is no problem with de…

84c8d4e

…precation of new parameter later on

Tweak docs

89c9183

Bump version

e188bbe

Improve docs

8c905bf

Add meta-descriptions of steps manifests

31be007

Add definition of output kinds for entities

f9a1368

Add endpoint to decsribe blocks

8aed48e

Add endpoint to validate workflow specification

1ea5752

Get rid of dead code

4c3a0df

Add docs for fields in manifests

b139781

Merge with fresh master

775f970

Improve docs, add registered workflows into inference pipeline

d720c7b

Add docs

e396238

Downgrade Annotated[] for py3.8

4682cec

Make linter happy

faa7723

Improve docs

4b581f0

Improve sdk docs

77cf972

PawelPeczek-Roboflow marked this pull request as ready for review March 29, 2024 11:45

PawelPeczek-Roboflow requested review from probicheaux and yeldarby March 29, 2024 11:45

PawelPeczek-Roboflow added 2 commits April 2, 2024 10:24

Fix typo

6caf827

Make linter happy

83b2f3d

yeldarby reviewed Apr 2, 2024

View reviewed changes

PawelPeczek-Roboflow added 4 commits April 2, 2024 21:45

Add docs with predictions decsription

383f413

Get rid of workflow_name and put workflow_id instead

c827fa1

Change detections into predictions in Crop step

384f3d5

Add changes to naming convention of QR- and BarCode- detectors

156016b

PawelPeczek-Roboflow requested a review from yeldarby April 2, 2024 20:39

yeldarby approved these changes Apr 2, 2024

View reviewed changes

PawelPeczek-Roboflow added 4 commits April 3, 2024 19:13

Rename YoloWorld block

01b9a5f

Rename YoloWorld block

2e2f150

Add alias of yoloworld

864841b

Fix setup.py

de6e8de

PawelPeczek-Roboflow merged commit e095fc7 into main Apr 3, 2024
26 checks passed

PawelPeczek-Roboflow deleted the feature/adjust_workflows_endpoints_add_descriptive_and_validation_capabilities branch April 3, 2024 18:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new endpoints for workflows and prepare for future deprecation #336

Add new endpoints for workflows and prepare for future deprecation #336

PawelPeczek-Roboflow commented Mar 27, 2024 •

edited

Loading

yeldarby left a comment

yeldarby Apr 2, 2024

PawelPeczek-Roboflow Apr 2, 2024

yeldarby Apr 2, 2024

PawelPeczek-Roboflow Apr 3, 2024

yeldarby Apr 2, 2024

PawelPeczek-Roboflow Apr 2, 2024

yeldarby Apr 2, 2024

PawelPeczek-Roboflow Apr 3, 2024

yeldarby Apr 2, 2024

PawelPeczek-Roboflow Apr 2, 2024

PawelPeczek-Roboflow Apr 2, 2024

yeldarby Apr 2, 2024

PawelPeczek-Roboflow commented Apr 2, 2024

yeldarby left a comment

yeldarby Apr 2, 2024

		@@ -432,31 +511,44 @@ def validate_field_binding(self, field_name: str, value: Any) -> None:


		class InstanceSegmentationModel(ObjectDetectionModel):

		@@ -676,15 +855,26 @@ def validate_field_binding(self, field_name: str, value: Any) -> None:


		class BarcodeDetection(BaseModel, StepInterface):

Add new endpoints for workflows and prepare for future deprecation #336

Add new endpoints for workflows and prepare for future deprecation #336

Conversation

PawelPeczek-Roboflow commented Mar 27, 2024 • edited Loading

Description

Changes in workflows endpoints

Adjusted sdk client to changes

Maintained backward compatibility of endpoints

Provided self-descriptive capabilities for workflows blocks and endpoints to describe all loaded steps

Provided endpoint to validate workflows JSON definitions

Improved significantly workflows syntax validation by establishing typedefs with constraint checks in pydantic

Registered workflows in InferencePipeline

Fixed couple of bugs

Type of change

How has this change been tested, please provide a testcase or example of how you tested the change?

Any specific deployment considerations

Docs

yeldarby left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PawelPeczek-Roboflow commented Apr 2, 2024

yeldarby left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PawelPeczek-Roboflow commented Mar 27, 2024 •

edited

Loading

Provided self-descriptive capabilities for `workflows` blocks and endpoints to describe all loaded steps

Provided endpoint to validate `workflows` JSON definitions

Improved significantly `workflows` syntax validation by establishing typedefs with constraint checks in `pydantic`

Registered workflows in `InferencePipeline`