DemahAlmutairi commited on
Commit
6173fb2
·
verified ·
1 Parent(s): f2d18be

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +6 -14
README.md CHANGED
@@ -11,12 +11,10 @@ pinned: false
11
 
12
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
13
 
14
- Here's a README file that covers the required topics for your Gradio interface project:
15
-
16
  # README
17
 
18
  ## Project Objectives
19
- The primary objective of this project is to create an interactive web application that allows users to input images or sketches to generate captions in English and translate those captions into Arabic. This application leverages advanced machine learning models to provide a seamless experience in image captioning and bilingual translation.
20
 
21
  ## Description of Implemented Pipelines
22
  The application utilizes two key pipelines from the Hugging Face Transformers library:
@@ -30,22 +28,19 @@ The application utilizes two key pipelines from the Hugging Face Transformers li
30
  - This model translates the generated English caption into Arabic. It ensures that the translation retains the meaning and context of the original text, making it suitable for Arabic-speaking users.
31
 
32
  ## Instructions for Using the Interface
33
- 1. **Accessing the Interface**:
34
- - Run the provided code in a Python environment with the Gradio library installed.
35
- - The web interface will launch automatically.
36
 
37
- 2. **Input Options**:
38
  - **Upload Tab**: Users can upload an image from their device.
39
  - **Sketch Tab**: Users can draw a sketch of an object using the sketchpad.
40
 
41
- 3. **Generating Captions**:
42
  - After inputting an image or sketch, click the "Submit" button.
43
  - The application will process the input and display the generated English caption and its Arabic translation in the output fields.
44
 
45
- 4. **Examples**:
46
  - The "Example Prompts" section provides sample images. Clicking on these examples will populate the upload interface with the selected image.
47
 
48
- 5. **Clearing Inputs**:
49
  - Use the "Clear" button to reset the inputs in both tabs.
50
 
51
  ## Justifications for Model and Pipeline Choices
@@ -54,7 +49,4 @@ The application utilizes two key pipelines from the Hugging Face Transformers li
54
  - **Translation**: The `facebook/nllb-200-distilled-600M` model is selected for its capability to handle multiple languages effectively, ensuring that the translation is contextually relevant and accurate for Arabic users.
55
 
56
  ## Bilingual Implementation
57
- The application addresses bilingual implementation by utilizing a dedicated translation pipeline that converts English captions into Arabic. This ensures accessibility for Arabic-speaking users, allowing them to understand the content generated by the image captioning model. The choice of model for translation is based on its ability to provide high-quality translations across different contexts.
58
-
59
- ## Conclusion
60
- This project demonstrates the integration of image processing and natural language processing to create a user-friendly application that facilitates image captioning and bilingual translation. By leveraging state-of-the-art models, the application aims to enhance user interaction and accessibility in multilingual contexts.
 
11
 
12
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
13
 
 
 
14
  # README
15
 
16
  ## Project Objectives
17
+ The primary objective of this project is to create an interactive application that allows users to input images or sketches to generate captions in English and translate those captions into Arabic.
18
 
19
  ## Description of Implemented Pipelines
20
  The application utilizes two key pipelines from the Hugging Face Transformers library:
 
28
  - This model translates the generated English caption into Arabic. It ensures that the translation retains the meaning and context of the original text, making it suitable for Arabic-speaking users.
29
 
30
  ## Instructions for Using the Interface
 
 
 
31
 
32
+ 1. **Input Options**:
33
  - **Upload Tab**: Users can upload an image from their device.
34
  - **Sketch Tab**: Users can draw a sketch of an object using the sketchpad.
35
 
36
+ 2. **Generating Captions**:
37
  - After inputting an image or sketch, click the "Submit" button.
38
  - The application will process the input and display the generated English caption and its Arabic translation in the output fields.
39
 
40
+ 3. **Examples**:
41
  - The "Example Prompts" section provides sample images. Clicking on these examples will populate the upload interface with the selected image.
42
 
43
+ 4. **Clearing Inputs**:
44
  - Use the "Clear" button to reset the inputs in both tabs.
45
 
46
  ## Justifications for Model and Pipeline Choices
 
49
  - **Translation**: The `facebook/nllb-200-distilled-600M` model is selected for its capability to handle multiple languages effectively, ensuring that the translation is contextually relevant and accurate for Arabic users.
50
 
51
  ## Bilingual Implementation
52
+ The application addresses bilingual implementation by utilizing a dedicated translation pipeline that converts English captions into Arabic. This ensures accessibility for Arabic-speaking users, allowing them to understand the content generated by the image captioning model.