maguid28 commited on
Commit
ccefd9b
·
verified ·
1 Parent(s): ed711c9

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +13 -7
README.md CHANGED
@@ -1,16 +1,14 @@
1
  ---
2
  title: TranscriptTool - smolagent Transcription Tool
3
  emoji: 💬
4
- colorFrom: yellow
5
- colorTo: purple
6
  sdk: gradio
7
  sdk_version: 5.13.1
8
  app_file: app.py
9
  pinned: false
10
  license: apache-2.0
11
  short_description: smolagent tool to transcribe audio & video files
12
- thumbnail: >-
13
- https://cdn-uploads.huggingface.co/production/uploads/6339a72d593f7e383739348b/pE2FxleMKZLuJqjlg_ShH.png
14
  ---
15
 
16
  # TranscriptTool: A SmolAgent Tool for Audio/Video Transcription
@@ -60,7 +58,7 @@ To see how TranscriptTool operates within a SmolAgent framework:
60
 
61
  The `TranscriptTool` is also available as a tool through the Hugging Face API.
62
 
63
- #### How to Use the Tool via Hugging Face API
64
 
65
  1. **Install SmolAgents**
66
 
@@ -73,8 +71,16 @@ The `TranscriptTool` is also available as a tool through the Hugging Face API.
73
  You can load the tool directly using the Hugging Face API.
74
 
75
  ```python
76
- from smolagents import load_tool
77
- transcription_tool = load_tool("maguid28/TranscriptTool", trust_remote_code=True)
 
 
 
 
 
 
 
 
78
  ```
79
  ---
80
  ## License
 
1
  ---
2
  title: TranscriptTool - smolagent Transcription Tool
3
  emoji: 💬
4
+ colorFrom: green
5
+ colorTo: yellow
6
  sdk: gradio
7
  sdk_version: 5.13.1
8
  app_file: app.py
9
  pinned: false
10
  license: apache-2.0
11
  short_description: smolagent tool to transcribe audio & video files
 
 
12
  ---
13
 
14
  # TranscriptTool: A SmolAgent Tool for Audio/Video Transcription
 
58
 
59
  The `TranscriptTool` is also available as a tool through the Hugging Face API.
60
 
61
+ #### How to Use the Tool via Hugging Face API (Currently not working)
62
 
63
  1. **Install SmolAgents**
64
 
 
71
  You can load the tool directly using the Hugging Face API.
72
 
73
  ```python
74
+ from smolagents import Tool
75
+ transcript_tool = Tool.from_space(
76
+ "maguid28/TranscriptTool",
77
+ name="TranscriptTool",
78
+ description="""
79
+ A smolagent tool for transcribing audio and video files into text. This tool utilises Whisper for transcription
80
+ and ffmpeg for media conversion, enabling agents to process multimedia inputs into text. The tool supports robust
81
+ file handling, including format conversion to WAV and dynamic device selection for optimal performance.
82
+ """
83
+ )
84
  ```
85
  ---
86
  ## License