Update app.py

app.py

@@ -124,8 +124,140 @@ url_endpoint = st.selectbox("Select Inference URL", [
     "https://api-inference.huggingface.co/models/gpt2"
 ])
 
+st.markdown("Welcome to the Hugging Face Agent and Tools app! This app allows you to interact with various tools using the Hugging Face API.")
+    
+
+
+# Add a markdown section for tool descriptions
+with st.expander("Expand to see description"):
+    
+    # Add a section for the app's description
+    st.markdown(''' 
+                    # Hugging Face Agent and Tools App
+                    
+                    ## Description
+                    Welcome to the Hugging Face Agent and Tools app! This app provides an interactive interface for utilizing various tools through the Hugging Face API. You can choose an inference URL and select from a variety of tools to perform different tasks.
+                    
+                    ## Examples
+                    1. **Generate a Random Character**:
+                       - Choose the desired URL and the 'Random Character Tool'.
+                       
+                    2. **Sentiment Analysis**:
+                       - Choose the desired URL and the 'Sentiment Analysis Tool'.
+                       - Sample: What is the sentiment for "Hello, I am happy"?
+                    
+                    3. **Word Count**:
+                       - Choose the desired URL and the 'Word Counter Tool'.
+                       - Sample: Count the words in "Hello, I am Christof".
+                    
+                    ## Tools
+                    To interact with the tools, expand the section below to see tool descriptions and select the tools you want to use.
+                    
+                    <details>
+                    <summary>Expand to see tool descriptions</summary>
+                    
+                    ### Tool Descriptions
+                    - **random-character-tool:** Generates a random character.
+                    - **text-generation-tool:** Generates text based on a prompt.
+                    - **sentiment-tool:** Analyzes the sentiment of a given text.
+                    - **token-counter-tool:** Counts the tokens in a text.
+                    - **most-downloaded-model:** Provides information about the most downloaded model.
+                    - **rag-tool:** Utilizes Retrieval-Augmented Generation (RAG) for text generation.
+                    - **word-counter-tool:** Counts the words in a text.
+                    - **sentence-counter-tool:** Counts the sentences in a text.
+                    - **EmojifyTextTool:** Emojifies the given text.
+                    - **NamedEntityRecognitionTool:** Identifies named entities in a text.
+                    - **TextDownloadTool:** Downloads text from a given URL.
+                    - **source-code-retriever-tool:** Retrieves source code from a given URL.
+                    - **text-to-image:** Generates an image from text.
+                    - **text-to-video:** Generates a video from text.
+                    - **image-transformation:** Applies transformations to images.
+                    - **latent-upscaler-tool:** Upscales images using latent space.
+                    
+                    </details>
+                    
+                    ## Usage
+                    1. Choose the desired inference URL from the dropdown.
+                    2. Expand the tool selection section and choose the tools you want to use.
+                    3. Enter a message in the chat input to interact with the Hugging Face Agent.
+                    4. View the assistant's responses, which may include images, audio, text, or other visualizations based on the selected tools.
+                    
+                    Feel free to explore and experiment with different tools to achieve various tasks!
+
+                ''')
+
+# Add a markdown section for code descriptions
+with st.expander("Expand to see developer description"):
+     
+    st.markdown(''' 
+
+        # Hugging Face Agent and Tools Code Overview
+        
+        ## Overview
+        The provided Python code implements an interactive Streamlit web application that allows users to interact with various tools through the Hugging Face API. The app integrates Hugging Face models and tools, enabling users to perform tasks such as text generation, sentiment analysis, and more.
+        
+        ## Imports
+        The code imports several external libraries and modules, including:
+        - `streamlit`: For building the web application.
+        - `os`: For interacting with the operating system.
+        - `base64`, `io`, `Image` (from `PIL`), `AudioSegment` (from `pydub`), `IPython`, `sf`: For handling images and audio.
+        - `requests`: For making HTTP requests.
+        - `pandas`: For working with DataFrames.
+        - `matplotlib.figure`, `numpy`: For visualization.
+        - `altair`, `Plot` (from `bokeh.models`), `px` (from `plotly.express`), `pdk` (from `pydeck`): For different charting libraries.
+        - `time`: For handling time-related operations.
+        - `transformers`: For loading tools and agents.
+        
+        ## ToolLoader Class
+        The `ToolLoader` class is responsible for loading tools based on their names. It has methods to load tools from a list of tool names and handles potential errors during loading.
+        
+        ## CustomHfAgent Class
+        The `CustomHfAgent` class extends the base `Agent` class from the `transformers` module. It is designed to interact with a remote inference API and includes methods for generating text based on a given prompt.
+        
+        ## Tool Loading and Customization
+        - Tool names are defined in the `tool_names` list.
+        - The `ToolLoader` instance (`tool_loader`) loads tools based on the provided names.
+        - The `CustomHfAgent` instance (`agent`) is created with a specified URL endpoint, token, and additional tools.
+        - New tools can be added by appending their names to the `tool_names` list.
+        
+        ## Streamlit App
+        The Streamlit app is structured as follows:
+        1. Tool selection dropdown for choosing the inference URL.
+        2. An expander for displaying tool descriptions.
+        3. An expander for selecting tools.
+        4. Examples and instructions for the user.
+        5. A chat interface for user interactions.
+        6. Handling of user inputs, tool selection, and agent responses.
+        
+        ## Handling of Responses
+        The code handles various types of responses from the agent, including images, audio, text, DataFrames, and charts. The responses are displayed in the Streamlit app based on their types.
+        
+        ## How to Run
+        1. Install required dependencies with `pip install -r requirements.txt`.
+        2. Run the app with `streamlit run <filename.py>`.
+        
+        ## Notes
+        - The code emphasizes customization and extensibility, allowing developers to easily add new tools and interact with the Hugging Face API.
+        - Ensure proper configuration, such as setting the Hugging Face token as an environment variable.
+
+          ''')
+
 # Add an expandable element for tools
 with st.expander("Expand to select tools"):
+
+    # Examples for the user perspective
+    st.markdown("### Examples:")
+    st.markdown("1. **Generate a Random Character**:")
+    st.markdown("   - Choose the desired URL and the 'Random Character Tool'.")
+    
+    st.markdown("2. **Sentiment Analysis**:")
+    st.markdown("   - Choose the desired URL and the 'Sentiment Analysis Tool'.")
+    st.markdown("   - Sample: What is the sentiment for \"Hello, I am happy\"?")
+    
+    st.markdown("3. **Word Count**:")
+    st.markdown("   - Choose the desired URL and the 'Word Counter Tool'.")
+    st.markdown("   - Sample: Count the words in \"Hello, I am Christof\".")
+    
     tool_checkboxes = [st.checkbox(f"{tool.name} --- {tool.description} ") for tool in tool_loader.tools]
 
 if "messages" not in st.session_state: