Skip to content

[Feat]support container install docs #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chengyupku merged 1 commit into from
Nov 7, 2025
Merged

[Feat]support container install docs #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/get_started/Installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@

We currently provide three methods to install **TileScale**:

**(optional)Prepare the container**:

Copilot AI Nov 7, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a space after '(optional)' for proper formatting. Should be '(optional) Prepare'.

Suggested change
**(optional)Prepare the container**:
**(optional) Prepare the container**:

Copilot uses AI. Check for mistakes.

```bash
docker pull nvcr.io/nvidia/pytorch:25.03-py3
docker run --name tilescale --ipc=host --network=host --privileged --cap-add=SYS_ADMIN --shm-size=10g --gpus=all -it nvcr.io/nvidia/pytorch:25.03-py3 /bin/bash

Copilot AI Nov 7, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Running the container with --privileged and --cap-add=SYS_ADMIN grants excessive permissions that could pose security risks. Consider whether these elevated privileges are truly necessary for TileScale installation. If only GPU access is required, the --gpus=all flag should suffice without privileged mode.

Suggested change
docker run --name tilescale --ipc=host --network=host --privileged --cap-add=SYS_ADMIN --shm-size=10g --gpus=all -it nvcr.io/nvidia/pytorch:25.03-py3 /bin/bash
docker run --name tilescale --ipc=host --network=host --shm-size=10g --gpus=all -it nvcr.io/nvidia/pytorch:25.03-py3 /bin/bash

Copilot uses AI. Check for mistakes.
echo -n > /etc/pip/constraint.txt

Copilot AI Nov 7, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Miniconda installer script is referenced without showing how to obtain it. Add a preceding step to download the installer, such as wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh or document that this assumes the installer is already present.

Suggested change
echo -n > /etc/pip/constraint.txt
echo -n > /etc/pip/constraint.txt
wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh # download Miniconda installer

Copilot uses AI. Check for mistakes.
bash Miniconda3-latest-Linux-x86_64.sh # install conda
conda install -c conda-forge libstdcxx-ng
```
Comment on lines +16 to +22

@coderabbitai coderabbitai Bot Nov 7, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

Fix hard tabs and incomplete setup instructions.

Two issues here:

  1. Line 18 contains hard tabs instead of spaces, which violates Markdown formatting standards (MD010).
  2. Line 20 references Miniconda3-latest-Linux-x86_64.sh without showing how to download or locate it, making the instructions incomplete.
 ```bash
 docker pull nvcr.io/nvidia/pytorch:25.03-py3
-docker run --name tilescale --ipc=host --network=host --privileged --cap-add=SYS_ADMIN --shm-size=10g --gpus=all -it nvcr.io/nvidia/pytorch:25.03-py3 /bin/bash	
+docker run --name tilescale --ipc=host --network=host --privileged --cap-add=SYS_ADMIN --shm-size=10g --gpus=all -it nvcr.io/nvidia/pytorch:25.03-py3 /bin/bash
 echo -n > /etc/pip/constraint.txt
-bash Miniconda3-latest-Linux-x86_64.sh # install conda
+wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
+bash Miniconda3-latest-Linux-x86_64.sh  # install conda
 conda install -c conda-forge libstdcxx-ng

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 markdownlint-cli2 (0.18.1)</summary>

18-18: Hard tabs
Column: 160

(MD010, no-hard-tabs)

</details>

</details>

<details>
<summary>🤖 Prompt for AI Agents</summary>

In docs/get_started/Installation.md around lines 16 to 22, fix the Markdown code
block by replacing hard tabs with spaces (remove the trailing hard tab on the
docker run line) and make the Miniconda install step complete by adding a
download command prior to running the installer (e.g., download
Miniconda3-latest-Linux-x86_64.sh from the official URL), then run the installer
as shown; ensure the code block uses spaces only and the sequence is: docker
pull, docker run (no trailing tab), echo to constraint.txt, wget the Miniconda
script, bash the installer, and then conda install libstdcxx-ng.


</details>

<!-- This is an auto-generated comment by CodeRabbit -->


1. **Clone the Repository**:

```bash
Expand Down
Loading