IceAge / README.md
UsmanGhias's picture
Updated README
40b08ff verified
metadata
language: en
tags:
  - tensorflow
  - gradio
  - image-processing
  - glaciers
license: apache-2.0
datasets:
  - custom
metrics:
  - accuracy
widget:
  - text: Upload an image of a glacier to predict boundaries.

Here's a complete and enhanced version of your Gradio interface documentation for the SGDNet model. This documentation can be part of your model card on Hugging Face or included as a README.md in your project repository. It provides clear instructions on setup, usage, and how to interact with the model through Gradio.


SGDNet Gradio Interface

This is a Gradio interface for the SGDNet model, designed to extract glacier boundaries from multisource remote sensing data. The interface provides a user-friendly method to upload satellite images and visualize the predicted glacier boundaries.

Setup Instructions

Follow these steps to get the Gradio interface up and running on your local machine:

Prerequisites

Ensure you have Python installed on your system. The interface is built using Gradio, and the model is implemented in TensorFlow.

Installation

  1. Clone the repository: Ensure you have git installed and then clone the repository containing the SGDNet model and the Gradio interface code.

    git clone https://huggingface.co/your_username/SGDNet-gradio
    cd SGDNet-gradio
    
  2. Install the required packages: Use pip to install the required Python packages from the requirements.txt file.

    pip install -r requirements.txt
    

Running the Interface

  1. Start the Gradio app: Run the Gradio interface using the command below. This command executes the Python script that launches the Gradio interface.

    python gradio_app.py
    
  2. Access the Interface: Open your web browser and navigate to the URL provided in the command line output (typically http://127.0.0.1:7860). This URL hosts your interactive Gradio interface.

How to Use the Interface

  • Upload Image: Click on the upload area or drag and drop an image file to upload a satellite image of a glacier.
  • Submit Image: After uploading the image, click the "Predict" button to process the image through the SGDNet model.
  • View Results: The interface will display the original image alongside the glacier boundary predictions, allowing you to compare and analyze the results.

Features

  • Interactive Uploads: Users can easily upload images through a simple web interface.
  • Real-time Predictions: The model processes images and provides predictions in real-time.
  • Visual Comparisons: Directly compare the uploaded images with their prediction outputs.

Further Help

If you encounter any issues or have questions about using the interface, please refer to the documentation on Hugging Face or submit an issue in the repository.