Joshua Lochner commited on
Commit
776c8b2
1 Parent(s): 921fb1d

Update README to include installation instructions

Browse files
Files changed (2) hide show
  1. Makefile +0 -8
  2. README.md +26 -18
Makefile DELETED
@@ -1,8 +0,0 @@
1
-
2
- PIP := pip3
3
-
4
- install:
5
- $(PIP) install -r requirements.txt
6
-
7
- run:
8
- streamlit run app.py
 
 
 
 
 
 
 
 
 
README.md CHANGED
@@ -11,12 +11,10 @@ pinned: true
11
  # SponsorBlock-ML
12
  Automatically detect in-video YouTube sponsorships, self/unpaid promotions, and interaction reminders. The model was trained using the [SponsorBlock](https://sponsor.ajay.app/) [database](https://sponsor.ajay.app/database) licensed used under [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/).
13
 
14
- Check out the demo application by visiting [https://xenova.github.io/sponsorblock-ml/](https://xenova.github.io/sponsorblock-ml/). You can also run it locally using `make run`.
15
 
16
  ---
17
-
18
-
19
- ## Predicting
20
 
21
  1. Download the repository:
22
  ```bash
@@ -24,24 +22,34 @@ Check out the demo application by visiting [https://xenova.github.io/sponsorbloc
24
  cd sponsorblock-ml
25
  ```
26
 
27
- 2. Run predictions:
28
- - Predict for a single video using the `--video_id` argument. For example:
29
- ```bash
30
- python src/predict.py --video_id zo_uoFI1WXM
31
- ```
 
 
 
 
 
 
 
 
 
 
32
 
33
- - Predict for multiple videos using the `--video_ids` argument. For example:
34
- ```bash
35
- python src/predict.py --video_ids IgF3OX8nT0w ao2Jfm35XeE
36
- ```
37
 
38
- - Predict for a whole channel using the `--channel_id` argument. For example:
39
 
40
- ```bash
41
- python src/predict.py --channel_id UCHnyfMqiRRG1u-2MsSQLbXA
42
- ```
43
 
44
- Note that on the first run, the program will download the necessary models (which may take some time).
45
 
46
 
47
  ---
 
11
  # SponsorBlock-ML
12
  Automatically detect in-video YouTube sponsorships, self/unpaid promotions, and interaction reminders. The model was trained using the [SponsorBlock](https://sponsor.ajay.app/) [database](https://sponsor.ajay.app/database) licensed used under [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/).
13
 
14
+ Check out the online demo application at [https://xenova.github.io/sponsorblock-ml/](https://xenova.github.io/sponsorblock-ml/), or follow the instructions below to run it locally.
15
 
16
  ---
17
+ ## Installation
 
 
18
 
19
  1. Download the repository:
20
  ```bash
 
22
  cd sponsorblock-ml
23
  ```
24
 
25
+ 2. Install the necessary dependencies:
26
+ ```bash
27
+ pip install -r requirements.txt
28
+ ```
29
+
30
+ 3. Run the application:
31
+ ```bash
32
+ streamlit run app.py
33
+ ```
34
+ ## Predicting
35
+
36
+ - Predict for a single video using the `--video_id` argument. For example:
37
+ ```bash
38
+ python src/predict.py --video_id zo_uoFI1WXM
39
+ ```
40
 
41
+ - Predict for multiple videos using the `--video_ids` argument. For example:
42
+ ```bash
43
+ python src/predict.py --video_ids IgF3OX8nT0w ao2Jfm35XeE
44
+ ```
45
 
46
+ - Predict for a whole channel using the `--channel_id` argument. For example:
47
 
48
+ ```bash
49
+ python src/predict.py --channel_id UCHnyfMqiRRG1u-2MsSQLbXA
50
+ ```
51
 
52
+ Note that on the first run, the program will download the necessary models (which may take some time).
53
 
54
 
55
  ---