infer_google_vision_web_detection
Ikomia HUB

infer_google_vision_web_detection

GitHub

About

1.0.0
Apache-2.0

Web Detection detects Web references to an image.

Task: OTHER
Web Detection
Cloud
Vision AI

Web Detection detects Web references to an image.

Running this algorithm requires:

  • a Google Cloud Vision API Key
  • a Google Cloud account with Cloud Vision API enable

Please refer to the 'Advanced Usage' section for guidance on how to set these up.

web detection illustration

🚀 Use with Ikomia API

1. Install Ikomia API

We strongly recommend using a virtual environment. If you're not sure where to start, we offer a tutorial here.

pip install ikomia

2. Create your workflow

from ikomia.dataprocess.workflow import Workflow
from ikomia.utils.displayIO import display

# Init your workflow
wf = Workflow()

# Add algorithm
algo = wf.add_task(name="infer_google_vision_web_detection", auto_connect=True)

# Set parameters
algo.set_parameters({
    'google_application_credentials':'PATH/TO/YOUR/GOOGLE/CLOUD/VISION/API/KEY.json'
})

# Run on your image
wf.run_on(url='https://cloud.google.com/static/vision/docs/images/carnaval_small.jpeg')

# Display your result
display(algo.get_image_with_graphics())

web_detection_output = algo.get_output(4).data
print(web_detection_output)

☀️ Use with Ikomia Studio

Ikomia Studio offers a friendly UI with the same features as the API.

  • If you haven't started using Ikomia Studio yet, download and install it from this page.

  • For additional guidance on getting started with Ikomia Studio, check out this blog post.

📝 Set algorithm parameters

  • output_folder (str): Specify the destination for saving the output data in JSON format. By default, the output will be stored in 'User/Ikomia/Plugins/Python/infer_google_vision_web_detection/output'
  • include_geo_results (bool) - default 'False': The Vision API can access geotag metadata in your image files to return more relevant web entities and pages. To allow geotag usage, specify 'includeGeoResults': true in your request.
from ikomia.dataprocess.workflow import Workflow

# Init your workflow
wf = Workflow()

# Add algorithm
algo = wf.add_task(name="infer_google_vision_web_detection", auto_connect=True)

algo.set_parameters({
    "param1": "value1",
    "param2": "value2",
    ...
})

🔍 Explore algorithm outputs

Every algorithm produces specific outputs, yet they can be explored them the same way using the Ikomia API. For a more in-depth understanding of managing algorithm outputs, please refer to the documentation.

import ikomia
from ikomia.dataprocess.workflow import Workflow

# Init your workflow
wf = Workflow()

# Add algorithm
algo = wf.add_task(name="infer_google_vision_web_detection", auto_connect=True)

# Set parameters
algo.set_parameters({
    'google_application_credentials':'PATH/TO/YOUR/GOOGLE/CLOUD/VISION/API/KEY.json'
})

# Run on your image
wf.run_on(url='https://cloud.google.com/static/vision/docs/images/carnaval_small.jpeg')

# Iterate over outputs
for output in algo.get_outputs():
    # Print information
    print(output)
    # Export it to JSON
    output.to_json()

Advanced usage

💡 How to generate a Google Cloud Vision API Key and enable Cloud Vision API?

🔑 Set the Google Cloud Vision API Key in your environment variable.

Permanently setting the 'GOOGLE_APPLICATION_CREDENTIALS' API Key in your environment variable enables the use of this algorithm without having to define the 'google_application_credentials' parameter every time.

Note: the key will still be required for deployments.

🔴 Deployment Limitations

This algorithm necessitates authentication to Google Cloud services via API keys. Consequently, it will not operate offline (e.g., in AWS Lambda) or in environments without internet access to communicate with Google Cloud services.

Ensure to manage API keys securely and avoid exposing them in public repositories or forums to prevent unauthorized usage. If the keys are compromised, be sure to revoke them immediately and generate new keys in the Google Cloud Console.

Developer

  • Ikomia
    Ikomia

License

Apache License 2.0
Read license full text

A permissive license whose main conditions require preservation of copyright and license notices. Contributors provide an express grant of patent rights. Licensed works, modifications, and larger works may be distributed under different terms and without source code.

PermissionsConditionsLimitations

Commercial use

License and copyright notice

Trademark use

Modification

State changes

Liability

Distribution

Warranty

Patent use

Private use

This is not legal advice: this description is for informational purposes only and does not constitute the license itself. Provided by choosealicense.com.