jbilcke-hf HF staff commited on
Commit
733cce1
1 Parent(s): 1efc350

update readme to add the disclaimer

Browse files
Files changed (1) hide show
  1. README.md +73 -4
README.md CHANGED
@@ -1,9 +1,78 @@
1
  ---
2
- title: beta
3
- emoji: 🤫
4
- colorFrom: white
5
- colorTo: gray
6
  sdk: docker
7
  pinned: false
8
  app_port: 7860
9
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: AI WebTV
3
+ emoji: 🔮
4
+ colorFrom: purple
5
+ colorTo: white
6
  sdk: docker
7
  pinned: false
8
  app_port: 7860
9
  ---
10
+
11
+ A generative AI WebTV, powered by Zeroscope and Hugging Face.
12
+
13
+ This is just the frontend part, you will need the media-server (also open source) to make it work.
14
+
15
+ Warning: this is an experimental, proof-of-concept project made in a few days.
16
+
17
+ It is not ready for production use by other people! Also, this use models that should only be used for research purposes (no commercial usage).
18
+
19
+ Note: this won't work on iOS due to an apparent ban on Media Source Extensions (available on iPadOS).
20
+
21
+ It should be possible however to use some other protocol or library.
22
+
23
+ # Installation
24
+ ## Building and run without Docker
25
+
26
+ ```bash
27
+ nvm use
28
+ npm i
29
+ ```
30
+
31
+ First setup some env vars:
32
+ WEBTV_VIDEOPATH="./sandbox/video"
33
+ WEBTV_AUDIOPATH="./sandbox/audio"
34
+ WEBTV_RTMP_URL="rtmp://localhost:1935/webtv"
35
+
36
+
37
+ In a terminal, run:
38
+
39
+ ```
40
+ ./scripts/init.sh
41
+ ```
42
+
43
+ Then run:
44
+
45
+ ```
46
+ ./scripts/audio.sh
47
+ ```
48
+
49
+ In another terminal, run:
50
+
51
+ ```
52
+ ./scripts/video.sh
53
+ ```
54
+
55
+ In another terminal, run:
56
+
57
+ ```
58
+ ./scripts/stream.sh
59
+ ```
60
+
61
+ In another terminal, run:
62
+
63
+ ```
64
+ npm run start
65
+ ```
66
+
67
+ ## Building and running with Docker
68
+
69
+ ```bash
70
+ npm run docker
71
+ ```
72
+
73
+ This script is a shortcut executing the following commands:
74
+
75
+ ```bash
76
+ docker build -t ai-webtv .
77
+ docker run -it -p 7860:7860 ai-webtv
78
+ ```