Upload directory 'repo', on 2024-06-10 10:41:35 UTC

.bashrc

@@ -0,0 +1,3 @@
+export PATH=$HOME/.local/bin:$PATH
+
+python $HOME/app/rich_print_help.py

.ipynb_checkpoints/README-checkpoint.md

@@ -0,0 +1,12 @@
+---
+title: Jupyter Github Action Runner
+emoji: 🌍
+colorFrom: gray
+colorTo: yellow
+sdk: docker
+pinned: false
+license: mit
+app_port: 7860
+---
+
+Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference

Dockerfile

@@ -0,0 +1,43 @@
+FROM python:3.8.1
+
+WORKDIR /code
+
+COPY ./requirements.txt /code/requirements.txt
+
+RUN apt-get update && \
+      apt-get install -y sudo tmux wget curl htop make tree nano vim cloc && \
+      apt-get install -y graphviz pandoc && \
+      apt-get install -y iputils-ping telnet && \
+      apt-get install -y git git-lfs
+
+RUN --mount=type=secret,id=PASSWORD,mode=0444,required=true \
+      useradd -m -u 1000 user && \
+      echo "user:$(cat /run/secrets/PASSWORD)" | chpasswd && \
+      adduser user sudo
+
+RUN pip install -U pip pysocks
+RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt
+     
+USER user
+ENV HOME=/home/user
+ENV PATH=$HOME/.local/bin:$PATH
+ENV SHELL=/bin/bash
+
+WORKDIR $HOME
+
+RUN mkdir -p $HOME/runner && \
+      cd $HOME/runner && \
+      curl -o actions-runner-linux-x64-2.317.0.tar.gz -L https://github.com/actions/runner/releases/download/v2.317.0/actions-runner-linux-x64-2.317.0.tar.gz && \
+      echo "9e883d210df8c6028aff475475a457d380353f9d01877d51cc01a17b2a91161d  actions-runner-linux-x64-2.317.0.tar.gz" | shasum -a 256 -c && \
+      tar xzf ./actions-runner-linux-x64-2.317.0.tar.gz
+
+COPY --chown=user . $HOME/app
+
+RUN cp $HOME/app/how_to_use_github_action_runner.md $HOME/how_to_use_github_action_runner.md
+COPY .bashrc $HOME/.bashrc_append
+RUN cat $HOME/.bashrc_append >> $HOME/.bashrc && \
+      rm $HOME/.bashrc_append
+
+EXPOSE     7860
+ENTRYPOINT []
+CMD        ["/bin/bash", "./app/run.sh"]

README.md

@@ -1,11 +1,12 @@
 ---
 title: Jupyter Github Action Runner
-emoji: 😻
+emoji: 🌍
 colorFrom: gray
 colorTo: yellow
 sdk: docker
 pinned: false
 license: mit
+app_port: 7860
 ---
 
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference

how_to_use_github_action_runner.md

@@ -0,0 +1,43 @@
+# Guide for Github Action Runner
+
+## Configure
+
+The runner toolkits are installed at `~/runner`.
+
+We have to configure it at the first time, after that you can start this runner.
+
+```shell
+cd ~/runner
+
+export GH_REPO=your/github_repository
+export TOKEN=your_github_action_token
+./config.sh --url $GH_REPO --token $TOKEN
+
+```
+
+## Start Runner
+
+```shell
+cd ~/runner
+./run.sh
+```
+
+## Delete Runner
+
+```shell
+cd ~/runner
+
+export TOKEN=your_github_action_token
+./config.sh remove --token $TOKEN
+```
+
+## Attention
+
+* Pros of HFSpace-hosted runner
+  * **Larger free disk space** (github action: 14G, hfspace: 50G)
+  * Highly-customizable running environment.
+* Cons of HFSpace-hosted runner
+  * **Much slower CPU speed** (time cost approx x2.5 of github action when running model inference)
+  * Many actions on github action market not compatible with non-github-action environments.
+* You have to customize your own running environment manually, by editing `Dockerfile` and rebuilding space.
+* **You don't have the root permission on hfspace runtime.** You have to install all the root-required dependencies (e.g. `apt/yum install xxx`) at docker build stage. The other dependencies (e.g. `pip install xxx`) can be installed at runtime.

requirements.txt

@@ -0,0 +1,4 @@
+jupyterlab==3.6.1
+jupyter-server==2.3.0
+tornado==6.2
+rich

rich_print_help.py

@@ -0,0 +1,10 @@
+import os
+
+from rich.console import Console
+from rich.markdown import Markdown
+
+console = Console()
+
+with open(os.path.expanduser('~/how_to_use_github_action_runner.md')) as f:
+    md = Markdown(f.read())
+    console.print(md)

run.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+PASSWORD="${PASSWORD:=huggingface}"
+echo "Starting Jupyter Lab with token $PASSWORD"
+
+jupyter lab \
+    --ip=0.0.0.0 \
+    --port=7860 \
+    --no-browser \
+    --allow-root \
+    --NotebookApp.token=$PASSWORD \
+    --NotebookApp.tornado_settings="{'headers': {'Content-Security-Policy': 'frame-ancestors *'}}" \
+    --NotebookApp.cookie_options="{'SameSite': 'None', 'Secure': True}" \
+    --NotebookApp.disable_check_xsrf=True
+