Skip to content

Commit 01f0c88

Browse files
committed
chore(docs): update document
Signed-off-by: scepter914 <scepter914@gmail.com>
1 parent 2ae19af commit 01f0c88

2 files changed

Lines changed: 33 additions & 10 deletions

File tree

README.md

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ If you want to contribute this project, please see the documents.
2121

2222
If you want to see example of the usage of `ml-cellar` as minimum MLOps, please see [ml-cellar-example](https://github.com/scepter914/ml-cellar-example) as reference.
2323

24-
### Install
24+
### 1. Install
2525

2626
- Install Rust
2727
- See [the official document](https://doc.rust-lang.org/cargo/getting-started/installation.html).
@@ -44,15 +44,20 @@ cargo install lfs-dal
4444
cargo install ml-cellar
4545
```
4646

47-
- If you build on local device, run below command.
47+
<details>
48+
<summary> How to build on local device</summary>
49+
50+
If you build on local device, run below command.
4851

4952
```sh
5053
git clone https://github.com/scepter914/ml-cellar-rs
5154
cd ml-cellar-rs
5255
cargo install --path .
5356
```
5457

55-
### Setup repository
58+
</details>
59+
60+
### 2. Setup repository
5661

5762
Let's open the cellar for AI models
5863

@@ -67,12 +72,28 @@ ml-cellar init
6772

6873
```toml
6974
[ml_cellar]
70-
custom_transfer_agent = True
75+
custom_transfer_agent = false
76+
```
77+
78+
### 3. (Option) Setup with AWS S3
79+
80+
Git LFS on GitHub has about 1 GB limit.
81+
If you need to handle files larger than 1 GB in the repository, I recommend integrating with AWS S3.
82+
83+
- Edit `.ml_cellar.toml` and change to `custom_transfer_agent = true`.
84+
85+
```toml
86+
[ml_cellar]
87+
custom_transfer_agent = true
88+
```
89+
90+
- Edit `.lfsdalconfig` if you use AWS S3.
7191

92+
```toml
7293
[lfs-dal]
73-
scheme = s3
74-
bucket = your_bucket
75-
region = your_region
94+
scheme = s3
95+
bucket = your_bucket
96+
region = your_region
7697
```
7798

7899
- Run setup command
@@ -81,7 +102,7 @@ custom_transfer_agent = True
81102
ml-cellar setup
82103
```
83104

84-
### Start project
105+
### 4. Start project
85106

86107
A project in `ml-cellar` is like creating shelves in a wine cellar.
87108
If ML models are like wine, then project boxes are the shelves where you store the wine.
@@ -131,7 +152,7 @@ template = "template.md"
131152
- Edit template.md
132153
- If you want to setup template.md for MLOps, then please see [the document](docs/docs_template.md).
133154

134-
### Commit ML model
155+
### 5. Commit ML model
135156

136157
Let's actually stock AI models on the shelves
137158

@@ -184,7 +205,7 @@ ml-cellar push
184205
ml-cellar pull
185206
```
186207

187-
### Use `ml-cellar` as model serve
208+
### 6. Use `ml-cellar` as model serve
188209

189210
A wine cellar is a storage facility, but it's also a facility for serving
190211

docs/docs_template.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ template = "template.md"
3030
- What you updated in training parameters
3131

3232
<details>
33+
<summary> Evaluation results </summary>
34+
3335
- Dataset
3436
- Version: {dataset_version}
3537
- Frame number: {dataset.frame_n}

0 commit comments

Comments
 (0)