Skip to content

Update README after PyPI release #81

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
merged 5 commits into from
Feb 21, 2025
Merged

Update README after PyPI release #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2df51df
x
SumanthRH Feb 21, 2025
795be85
x
SumanthRH Feb 21, 2025
d2a22e0
x
SumanthRH Feb 21, 2025
b2d1e0f
x
SumanthRH Feb 21, 2025
16ae089
x
SumanthRH Feb 21, 2025
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
20 changes: 15 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,21 +46,31 @@ We open source the code and scripts we used for data curation, training, and eva

## Usage

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

```shell
pip install skythought
```

### Installing from source

```shell
# Clone the repository
git clone https://github.com/NovaSky-AI/SkyThought.git
cd SkyThought
# installs shown for uv
uv venv python==3.10

# Create and activate a virtual environment (using uv here)
uv venv --python 3.10
source .venv/bin/activate

# Install the package in editable mode
uv pip install -e .
```

Running evaluation is as simple as:

```bash
skythought evaluate --model NovaSky-AI/Sky-T1-32B-Preview --task aime
skythought evaluate --model NovaSky-AI/Sky-T1-32B-Preview --task aime24
```

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

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


### Evaluation results
Expand Down
28 changes: 18 additions & 10 deletions examples/evaluate.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,27 +13,35 @@
"source": [
"### Installation and Setup\n",
"\n",
"Begin by cloning the SkyThought repository and installing the necessary packages.\n",
"You can install the latest release from PyPI, or install from source:\n",
"\n",
"We recommend using `uv` for package management (For installation, refer to the [offical guide](https://docs.astral.sh/uv/getting-started/installation)). "
"#### Installing from PyPI\n",
"\n",
"```shell\n",
"pip install skythought\n",
"```"
]
},
{
"cell_type": "code",
"execution_count": null,
"cell_type": "markdown",
"metadata": {},
"outputs": [],
"source": [
"#### Installing from source\n",
"\n",
"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",
"\n",
"```shell\n",
"# Clone the repository\n",
"!git clone https://github.com/NovaSky-AI/SkyThought.git\n",
"!cd SkyThought\n",
"git clone https://github.com/NovaSky-AI/SkyThought.git\n",
"cd SkyThought\n",
"\n",
"# Create and activate a virtual environment (using uv here)\n",
"!uv venv --python 3.10\n",
"!source .venv/bin/activate\n",
"uv venv --python 3.10\n",
"source .venv/bin/activate\n",
"\n",
"# Install the package in editable mode\n",
"!uv pip install -e ."
"uv pip install -e .\n",
"```"
]
},
{
Expand Down