Skip to content

Commit

Permalink
Update the readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
AnasMostefaoui committed Jan 27, 2023
1 parent 6dcdf7e commit 75aa130
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Image proposal with cropping flow
# Object detection with cropping flow

This repository contains a swift iOS project, that uses nyris SDK to take an image, see suggested objects from the image and enable custom cropping.

Expand All @@ -12,15 +12,15 @@ The project has the following dependencies installed via swift package manager:
## Camera
This is handled by `ImageCaptureController.swift` a subclass of `CameraController.swift` which uses nyris `CameraManager.swift` to handle Camera permission and setup.

`ImageCaptureController` offers the possibility to take a picture, loads its object proposal from nyris API, and send it to Object proposal and cropping screen
`ImageCaptureController` offers the possibility to take a picture, detect objects with nyris API, and send it to Object detection and cropping screen

## Object proposal and Cropping
## Object detection and Cropping
This is managed by `CropController.swift`, This screen will display the previously taken image, and layout the objects that nyris SDK found on the image. If the user clicks on an object, it will provide the possibility to change the object cropping.

Once the user validate the object and its size, the `CropController` will find offers and takes the user to results screen.

## nyris service
You can either use the nyris SDK if you wanna use `CropController` directly or you can use wrapper arround it called `VisualSearchService` that allows you to get both Object proposal and Offers at the same time.
You can either use the nyris SDK if you wanna use `CropController` directly or you can use wrapper arround it called `VisualSearchService` that allows you to get both Object detection and Offers at the same time.

## Navigation
The navigation is done with the help of `DataTransferProtocol` This is a simple protocol that helps passing data between controllers. You can use your own system.
Expand Down

0 comments on commit 75aa130

Please sign in to comment.