Skip to content

Commit 834dbf7

Browse files
authored
Update README after PyPI release (#81)
1 parent 5433333 commit 834dbf7

File tree

2 files changed

+33
-15
lines changed

2 files changed

+33
-15
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,21 +46,31 @@ We open source the code and scripts we used for data curation, training, and eva
4646

4747
## Usage
4848

49-
First, clone the repository and install the package
49+
You can install the latest release from PyPI or from [source](#installing-from-source):
5050

5151
```shell
52+
pip install skythought
53+
```
54+
55+
### Installing from source
56+
57+
```shell
58+
# Clone the repository
5259
git clone https://github.com/NovaSky-AI/SkyThought.git
5360
cd SkyThought
54-
# installs shown for uv
55-
uv venv python==3.10
61+
62+
# Create and activate a virtual environment (using uv here)
63+
uv venv --python 3.10
5664
source .venv/bin/activate
65+
66+
# Install the package in editable mode
5767
uv pip install -e .
5868
```
5969

6070
Running evaluation is as simple as:
6171

6272
```bash
63-
skythought evaluate --model NovaSky-AI/Sky-T1-32B-Preview --task aime
73+
skythought evaluate --model NovaSky-AI/Sky-T1-32B-Preview --task aime24
6474
```
6575

6676
We support a wide variety of datasets in mathematics, science and coding:
@@ -80,7 +90,7 @@ We support a wide variety of datasets in mathematics, science and coding:
8090
- GSM8K
8191
- AIME'25
8292

83-
For more details, please refer to our [evaluation guide](examples/evaluate.ipynb) and the [README](skythought/evals/README.md).
93+
For more details, please refer to our [evaluation guide](examples/evaluate.ipynb) and the [evaluation README](skythought/evals/README.md).
8494

8595

8696
### Evaluation results

examples/evaluate.ipynb

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,27 +13,35 @@
1313
"source": [
1414
"### Installation and Setup\n",
1515
"\n",
16-
"Begin by cloning the SkyThought repository and installing the necessary packages.\n",
16+
"You can install the latest release from PyPI, or install from source:\n",
1717
"\n",
18-
"We recommend using `uv` for package management (For installation, refer to the [offical guide](https://docs.astral.sh/uv/getting-started/installation)). "
18+
"#### Installing from PyPI\n",
19+
"\n",
20+
"```shell\n",
21+
"pip install skythought\n",
22+
"```"
1923
]
2024
},
2125
{
22-
"cell_type": "code",
23-
"execution_count": null,
26+
"cell_type": "markdown",
2427
"metadata": {},
25-
"outputs": [],
2628
"source": [
29+
"#### Installing from source\n",
30+
"\n",
31+
"For installing from source, we recommend using uv for package management (For uv installation, refer to the [official guide](https://docs.astral.sh/uv/getting-started/installation)).\n",
32+
"\n",
33+
"```shell\n",
2734
"# Clone the repository\n",
28-
"!git clone https://github.com/NovaSky-AI/SkyThought.git\n",
29-
"!cd SkyThought\n",
35+
"git clone https://github.com/NovaSky-AI/SkyThought.git\n",
36+
"cd SkyThought\n",
3037
"\n",
3138
"# Create and activate a virtual environment (using uv here)\n",
32-
"!uv venv --python 3.10\n",
33-
"!source .venv/bin/activate\n",
39+
"uv venv --python 3.10\n",
40+
"source .venv/bin/activate\n",
3441
"\n",
3542
"# Install the package in editable mode\n",
36-
"!uv pip install -e ."
43+
"uv pip install -e .\n",
44+
"```"
3745
]
3846
},
3947
{

0 commit comments

Comments
 (0)