Skip to content

Commit 1d3b182

Browse files
authored
Merge pull request #253 from CerebriumAI/update-installation-docs
Update installation docs
2 parents 84304ce + 3176653 commit 1d3b182

File tree

2 files changed

+56
-8
lines changed

2 files changed

+56
-8
lines changed

cerebrium/getting-started/introduction.mdx

Lines changed: 55 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,61 @@ Setting up and deploying an app on Cerebrium takes just a few steps:
2121

2222
### 1. Install the CLI
2323

24+
<Tabs>
25+
<Tab title="Python (pip)">
26+
2427
```bash
2528
pip install cerebrium
29+
```
30+
31+
</Tab>
32+
<Tab title="macOS (Homebrew)">
33+
34+
```bash
35+
brew tap cerebriumai/tap
36+
brew install cerebrium
37+
```
38+
39+
</Tab>
40+
<Tab title="Linux">
41+
42+
```bash
43+
# Ubuntu/Debian
44+
wget https://github.com/CerebriumAI/cerebrium/releases/latest/download/cerebrium_linux_amd64.deb
45+
sudo dpkg -i cerebrium_linux_amd64.deb
46+
47+
# Or binary installation
48+
curl -L https://github.com/CerebriumAI/cerebrium/releases/latest/download/cerebrium_cli_linux_amd64.tar.gz | tar xz
49+
sudo mv cerebrium /usr/local/bin/
50+
```
51+
52+
</Tab>
53+
<Tab title="Windows">
54+
55+
```powershell
56+
# PowerShell (Run as Administrator)
57+
Invoke-WebRequest -Uri "https://github.com/CerebriumAI/cerebrium/releases/latest/download/cerebrium_cli_windows_amd64.zip" -OutFile "cerebrium.zip"
58+
Expand-Archive -Path "cerebrium.zip" -DestinationPath "."
59+
# Add cerebrium.exe to PATH
60+
```
61+
62+
</Tab>
63+
</Tabs>
64+
65+
### 2. Login to CLI
66+
67+
```bash
2668
cerebrium login # Redirects to your browser for authentication
2769
```
2870

29-
### 2. Initialize a Project
71+
### 3. Initialize a Project
3072

3173
```bash
3274
cerebrium init my-first-app
3375
cd my-first-app
3476
```
3577

36-
This creates a basic project with `main.py` for app code and `cerebrium.toml` for configuration. This is was the main.py file contains:
78+
This creates a basic project with `main.py` for app code and `cerebrium.toml` for configuration. This is what the main.py file contains:
3779

3880
```python
3981
def run(prompt: str):
@@ -42,7 +84,7 @@ def run(prompt: str):
4284
return {"my_result": prompt}
4385
```
4486

45-
### 3. Run code remotely
87+
### 4. Run code remotely
4688

4789
We can then run this function in the cloud and pass it a prompt.
4890

@@ -56,7 +98,7 @@ Use the `run` functionality for quick code iteration and testing snippets or onc
5698

5799
Let us now turn this into a scalable REST endpoint - something we could put in production!
58100

59-
### 4. Deploy your app
101+
### 5. Deploy your app
60102

61103
Run the following command:
62104

@@ -85,3 +127,12 @@ For a detailed explanation of how Cerebrium builds and manages container images,
85127
This targeted approach significantly reduces cold start times and optimizes
86128
resource usage.
87129
</Info>
130+
131+
## Further Examples
132+
133+
Below are a few tutorials to explore in order to learn more about the functionality Cerebrium has to offer:
134+
135+
- [Serve a OpenAI Compatible LLM with vLLM](/v4/examples/gpt-oss)
136+
- [Deploy a Twilio Voice Agent with Pipecat](/v4/examples/twilio-voice-agent)
137+
- [Run a Hyper-Parameter Sweep Training Llama 3.2](/v4/examples/wandb-sweep)
138+
- [Run a Gradio Chat Inferface](/v4/examples/asgi-gradio-interface)

docs.json

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,7 @@
2222
"groups": [
2323
{
2424
"group": "Getting Started",
25-
"pages": [
26-
"cerebrium/getting-started/introduction",
27-
"cerebrium/getting-started/collaborating"
28-
]
25+
"pages": ["cerebrium/getting-started/introduction"]
2926
},
3027
{
3128
"group": "Container Images",

0 commit comments

Comments
 (0)