norhan12 commited on
Commit
00470e4
·
1 Parent(s): 2d4edef

Fix missing configuration in README.md and update content

Browse files
Files changed (1) hide show
  1. README.md +68 -1
README.md CHANGED
@@ -1,3 +1,70 @@
 
 
 
 
 
 
 
 
 
1
 
 
2
 
3
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: EvalBot - Interview Analysis System
3
+ emoji: 🤖
4
+ colorFrom: blue
5
+ colorTo: green
6
+ sdk: docker
7
+ app_file: app.py
8
+ pinned: false
9
+ ---
10
 
11
+ # 🎤 EvalBot: Automated Interview Analysis System
12
 
13
+ Welcome to EvalBot, your AI-powered solution for comprehensive interview analysis!
14
+
15
+ EvalBot helps assess candidate performance in interviews by analyzing:
16
+ - **Voice Metrics:** Speaking rate, filler words, anxiety, confidence, and fluency.
17
+ - **Content Analysis:** Key themes, strengths, and areas for development in responses.
18
+ - **Speaker Identification:** Differentiating between interviewer and interviewee.
19
+ - **Acceptance Probability:** An estimated likelihood of acceptance based on key performance indicators.
20
+
21
+ ## Features:
22
+ - **Audio Analysis:** Upload audio files (WAV, MP3, M4A, FLAC) or provide URLs.
23
+ - **Detailed PDF Reports:** Get professional, structured reports with key insights and actionable recommendations.
24
+ - **API Access:** Integrate EvalBot's analysis capabilities into your own applications.
25
+
26
+ ## How to Use the API:
27
+
28
+ You can interact with EvalBot's API using the `gradio_client` library in Python.
29
+
30
+ 1. **Install the client:**
31
+ ```bash
32
+ pip install gradio_client
33
+ ```
34
+
35
+ 2. **Use the API to analyze audio (accepts multiple URLs):**
36
+
37
+ ```python
38
+ from gradio_client import Client, handle_file
39
+ import os
40
+
41
+ # Replace with your actual Space URL (e.g., [https://huggingface.co/spaces/YOUR_USERNAME/YOUR_SPACE_NAME](https://huggingface.co/spaces/YOUR_USERNAME/YOUR_SPACE_NAME))
42
+ SPACE_URL = "[https://huggingface.co/spaces/norhan12/YOUR_NEW_SPACE_NAME](https://huggingface.co/spaces/norhan12/YOUR_NEW_SPACE_NAME)" # REMEMBER TO UPDATE THIS
43
+
44
+ # Ensure your Hugging Face Access Token is set as an environment variable (for private spaces)
45
+ # HF_ACCESS_TOKEN = os.getenv("HF_TOKEN")
46
+
47
+ client = Client(SPACE_URL) # , hf_token=HF_ACCESS_TOKEN # Uncomment if your space is private
48
+
49
+ # List of audio URLs to analyze
50
+ audio_interview_urls = [
51
+ "[https://www.soundhelix.com/examples/mp3/SoundHelix-Song-1.mp3](https://www.soundhelix.com/examples/mp3/SoundHelix-Song-1.mp3)",
52
+ "[https://www.soundhelix.com/examples/mp3/SoundHelix-Song-2.mp3](https://www.soundhelix.com/examples/mp3/SoundHelix-Song-2.mp3)",
53
+ # Add more URLs as needed
54
+ ]
55
+
56
+ try:
57
+ result = client.predict(
58
+ file=handle_file(audio_interview_urls),
59
+ api_name="/analyze_multiple_audios" # Ensure this matches your function name in app.py
60
+ )
61
+
62
+ print("Combined Analysis Summary:", result[0])
63
+ print("Detailed Analysis (JSON Array):", result[1])
64
+ print("Downloadable PDF Paths:", result[2])
65
+
66
+ except Exception as e:
67
+ print(f"An error occurred while calling the API: {e}")
68
+ ```
69
+
70
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference