sandesh-bharadwaj commited on
Commit
d883ea7
1 Parent(s): 380a24a

Added instructions for running VidTune

Browse files
Files changed (1) hide show
  1. README.md +30 -0
README.md CHANGED
@@ -126,6 +126,36 @@ While VidTune is supported on CPU-only machines, we recommend using a GPU with m
126
  ## See VidTune in action!
127
  [![Watch the video](https://img.youtube.com/vi/knbQjWZtL3Y/maxresdefault.jpg)](https://youtu.be/knbQjWZtL3Y)
128
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
129
 
130
  <!-- ROADMAP -->
131
  ## Roadmap
 
126
  ## See VidTune in action!
127
  [![Watch the video](https://img.youtube.com/vi/knbQjWZtL3Y/maxresdefault.jpg)](https://youtu.be/knbQjWZtL3Y)
128
 
129
+ ## Running VidTune
130
+ First, clone the repository:
131
+ ```sh
132
+ git clone https://github.com/sandesh-bharadwaj/VidTune.git
133
+ cd VidTune
134
+ ```
135
+ ### Using conda
136
+ If you're using conda as your virtual environment manager, do the following:
137
+ ```
138
+ conda env create -f environment.yml
139
+ conda activate vidtune
140
+
141
+ streamlit run main.py
142
+ ```
143
+
144
+ ### Using python / pip
145
+ ```
146
+ pip install -r requirements.txt
147
+ streamlit run main.py
148
+ ```
149
+
150
+ ### Using Docker
151
+ - [Docker](https://docs.docker.com/engine/install/)
152
+ - [Nvidia Docker](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html#installing-with-apt)
153
+
154
+ ```
155
+ docker run --rm -it --gpus all -p 8003:8003 animikhaich/vidtune
156
+ ```
157
+
158
+
159
 
160
  <!-- ROADMAP -->
161
  ## Roadmap