Skip to content

Commit 0a1fb15

Browse files
committed
readme: update pip install ...
1 parent fd0fbe9 commit 0a1fb15

File tree

1 file changed

+4
-9
lines changed

1 file changed

+4
-9
lines changed

README.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,16 @@ This package provides utilities for saving and loading machine learning models u
99
- **Checkpoint Management**: Manage multiple checkpoints with ease.
1010
- **Cloud Integration**: Support for saving and loading models from cloud storage services.
1111

12-
[![lightning](https://img.shields.io/badge/-Lightning_2.0+-792ee5?logo=pytorchlightning&logoColor=white)](https://lightning.ai/)
1312
[![CI testing](https://github.com/Lightning-AI/models/actions/workflows/ci-testing.yml/badge.svg?event=push)](https://github.com/Lightning-AI/models/actions/workflows/ci-testing.yml)
1413
[![General checks](https://github.com/Lightning-AI/models/actions/workflows/ci-checks.yml/badge.svg?event=push)](https://github.com/Lightning-AI/models/actions/workflows/ci-checks.yml)
15-
[![Documentation Status](https://readthedocs.org/projects/models/badge/?version=latest)](https://models.readthedocs.io/en/latest/?badge=latest)
1614
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Lightning-AI/models/main.svg?badge_token=mqheL1-cTn-280Vx4cJUdg)](https://results.pre-commit.ci/latest/github/Lightning-AI/models/main?badge_token=mqheL1-cTn-280Vx4cJUdg)
1715

1816
## Installation
1917

2018
To install the package, you can use `pip` from [Test PyPI](https://test.pypi.org/project/litmodels/):
2119

2220
```bash
23-
pip install -i https://test.pypi.org/simple/ litmodels
21+
pip install -U --pre litmodels
2422
```
2523

2624
Or installing from source:
@@ -40,8 +38,7 @@ from litmodels import upload_model
4038
from litmodels.demos import BoringModel
4139

4240
# Define the model name - this should be unique to your model
43-
# The format is <organization>/<teamspace>/<model-name>
44-
MY_MODEL_NAME = "jirka/kaggle/lit-boring-model"
41+
MY_MODEL_NAME = "<organization>/<teamspace>/<model-name>"
4542

4643

4744
class LitModel(BoringModel):
@@ -70,8 +67,7 @@ from litmodels import download_model
7067
from litmodels.demos import BoringModel
7168

7269
# Define the model name - this should be unique to your model
73-
# The format is <organization>/<teamspace>/<model-name>:<model-version>
74-
MY_MODEL_NAME = "jirka/kaggle/lit-boring-model:latest"
70+
MY_MODEL_NAME = "<organization>/<teamspace>/<model-name>:<model-version>"
7571

7672

7773
class LitModel(BoringModel):
@@ -103,8 +99,7 @@ from litmodels import upload_model
10399
from litmodels.demos import BoringModel
104100

105101
# Define the model name - this should be unique to your model
106-
# The format is <organization>/<teamspace>/<model-name>
107-
MY_MODEL_NAME = "jirka/kaggle/lit-auto-encoder-callback"
102+
MY_MODEL_NAME = "<organization>/<teamspace>/<model-name>"
108103

109104

110105
class LitModel(BoringModel):

0 commit comments

Comments
 (0)