From 682db803ae6128d6b74cba968c23925d8f5effff Mon Sep 17 00:00:00 2001 From: David Chanin Date: Sat, 6 Apr 2024 17:16:50 +0100 Subject: [PATCH] chore: updating README.md with pip install instructions and PyPI badge --- README.md | 11 ++++++----- docs/index.md | 7 ++++--- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ee3db9ad..d417d5cf 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ Screenshot 2024-03-21 at 3 08 28 pm # SAE Lens +[![PyPI](https://img.shields.io/pypi/v/sae-lens?color=blue)](https://pypi.org/project/sae-lens/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -[![build](https://github.com/jbloomAus/mats_sae_training/actions/workflows/build.yml/badge.svg)](https://github.com/jbloomAus/mats_sae_training/actions/workflows/build.yml) -[![Deploy Docs](https://github.com/jbloomAus/mats_sae_training/actions/workflows/deploy_docs.yml/badge.svg)](https://github.com/jbloomAus/mats_sae_training/actions/workflows/deploy_docs.yml) -[![codecov](https://codecov.io/gh/jbloomAus/mats_sae_training/graph/badge.svg?token=N83NGH8CGE)](https://codecov.io/gh/jbloomAus/mats_sae_training) +[![build](https://github.com/jbloomAus/SAELens/actions/workflows/build.yml/badge.svg)](https://github.com/jbloomAus/SAELens/actions/workflows/build.yml) +[![Deploy Docs](https://github.com/jbloomAus/SAELens/actions/workflows/deploy_docs.yml/badge.svg)](https://github.com/jbloomAus/SAELens/actions/workflows/deploy_docs.yml) +[![codecov](https://codecov.io/gh/jbloomAus/SAELens/graph/badge.svg?token=N83NGH8CGE)](https://codecov.io/gh/jbloomAus/SAELens) SAELens exists to help researchers: - Train sparse autoencoders. @@ -15,10 +16,10 @@ SAELens exists to help researchers: ### Set Up -This project uses [Poetry](https://python-poetry.org/) for dependency management. Ensure Poetry is installed, then to install the dependencies, run: +This package is available on PyPI. You can install it via pip: ``` -poetry install +pip install sae-lens ``` ### Loading Sparse Autoencoders from Huggingface diff --git a/docs/index.md b/docs/index.md index e6bcb2a8..485dd148 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,10 +1,11 @@ Screenshot 2024-03-21 at 3 08 28 pm # SAELens +[![PyPI](https://img.shields.io/pypi/v/sae-lens?color=blue)](https://pypi.org/project/sae-lens/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -[![build](https://github.com/jbloomAus/mats_sae_training/actions/workflows/tests.yml/badge.svg)](https://github.com/jbloomAus/mats_sae_training/actions/workflows/tests.yml) -[![Deploy Docs](https://github.com/jbloomAus/mats_sae_training/actions/workflows/deploy_docs.yml/badge.svg)](https://github.com/jbloomAus/mats_sae_training/actions/workflows/deploy_docs.yml) -[![codecov](https://codecov.io/gh/jbloomAus/mats_sae_training/graph/badge.svg?token=N83NGH8CGE)](https://codecov.io/gh/jbloomAus/mats_sae_training) +[![build](https://github.com/jbloomAus/SAELens/actions/workflows/build.yml/badge.svg)](https://github.com/jbloomAus/SAELens/actions/workflows/build.yml) +[![Deploy Docs](https://github.com/jbloomAus/SAELens/actions/workflows/deploy_docs.yml/badge.svg)](https://github.com/jbloomAus/SAELens/actions/workflows/deploy_docs.yml) +[![codecov](https://codecov.io/gh/jbloomAus/SAELens/graph/badge.svg?token=N83NGH8CGE)](https://codecov.io/gh/jbloomAus/SAELens) The SAELens training codebase exists to help researchers: