Skip to content

Commit f3ef036

Browse files
committed
fix(readme): chatgpt recommended fixes
1 parent 56e79ab commit f3ef036

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

β€ŽREADME.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,11 @@ import videodb
6565
conn = videodb.connect(api_key="YOUR_API_KEY")
6666
```
6767

68-
## Working with a single Video
68+
## Working with a Single Video
6969

7070
---
7171

72-
⬆️ **Uploading a Video**
72+
### ⬆️ Uploading a Video
7373

7474
Now that you have established a connection to VideoDB, you can upload your videos using `conn.upload()`.
7575
You can directly upload from `youtube`, `any public url`, `S3 bucket` or a `local file path`. A default collection is created when you create your first connection.
@@ -85,9 +85,9 @@ video_f = conn.upload(file_path="./my_video.mp4")
8585

8686
```
8787

88-
### πŸ“Ί Viewing your video
88+
### πŸ“Ί View your Video
8989

90-
Your video is instantly available for viewing in 720p resolution ⚑️
90+
Once uploaded, your video is immediately available for viewing in 720p resolution. ⚑️
9191

9292
- Generate a streamable url for the video using video.generate_stream()
9393
- Preview the video using video.play(). This will open the video in your default browser/notebook
@@ -97,17 +97,17 @@ video.generate_stream()
9797
video.play()
9898
```
9999

100-
### ⛓️ Stream Sections of videos
100+
### ⛓️ Stream Specific Sections of Videos
101101

102102
You can easily clip specific sections of a video by passing a timeline of the start and end timestamps (in seconds) as a parameter.
103-
For example, this will generate and play a compilation of the fist `10 seconds` and the clip between the `120th` and the `140th` second.
103+
For example, this will generate and play a compilation of the first `10 seconds` and the clip between the `120th` and the `140th` second.
104104

105105
```python
106106
stream_link = video.generate_stream(timeline=[[0,10], [120,140]])
107107
play_stream(stream_link)
108108
```
109109

110-
### πŸ” Searching inside a video
110+
### πŸ” Search Inside a Video
111111

112112
To search bits inside a video, you have to `index` the video first. This can be done by a simple command.
113113
_P.S. Indexing may take some time for longer videos._
@@ -127,9 +127,9 @@ In the future you'll be able to index videos using:
127127
2. **Faces**.
128128
3. **Specific domain Index** like Football, Baseball, Drone footage, Cricket etc.
129129

130-
### Viewing Search Results :
130+
### Viewing Search Results
131131

132-
`video.search()` will return a `SearchResults` object, which contains the sections or as we call them, `shots` of videos which semantically match your search query.
132+
`video.search()` returns a `SearchResults` object, which contains the sections or as we call them, `shots` of videos which semantically match your search query.
133133

134134
- `result.get_shots()` Returns a list of Shot(s) that matched the search query.
135135
- `result.play()` Returns a playable url for the video (similar to video.play()) you can open this link in the browser, or embed it into your website using an iframe.
@@ -140,7 +140,7 @@ In the future you'll be able to index videos using:
140140

141141
`VideoDB` can store and search inside multiple videos with ease. By default, videos are uploaded to your default collection.
142142

143-
### πŸ”„ Using Collection to upload multiple Videos
143+
### πŸ”„ Using Collection to Upload Multiple Videos
144144

145145
```python
146146
# Get the default collection
@@ -157,7 +157,7 @@ coll.upload(url="https://www.youtube.com/watch?v=uak_dXHh6s4")
157157
- `coll.get_video(video_id)`: Returns a Video object, corresponding video from the provided `video_id`.
158158
- `coll.delete_video(video_id)`: Deletes the video from the Collection.
159159

160-
### πŸ“‚ Search inside Collection
160+
### πŸ“‚ Search Inside Collection
161161

162162
You can simply Index all the videos in a collection and use the search method to find relevant results.
163163
Here we are indexing the spoken content of a collection and performing semantic search.

0 commit comments

Comments
Β (0)