feat(ml-cellar): add clone (#12)

Signed-off-by: scepter914 <scepter914@gmail.com>

Author: scepter914

README.md

@@ -13,6 +13,10 @@ As a result, existing MLOps software has primarily targeted companies that can a
 - Feature
   - [ ] [Custom Transfer Agent](docs/docs_custom_transfer_agent.md)
 
+## Related resource
+
+- [ml-cellar-example](https://github.com/scepter914/ml-cellar-example): An example of ML model registry by `ml-cellar`.
+
 ## GitHub Git LFS usage & billing notice
 
 This repository uses Git LFS (Large File Storage) to manage large files.
@@ -35,7 +39,7 @@ If you want to see example of the usage of `ml-cellar` as minimum MLOps, please
 ### 1. Install
 
 - Install GitLFS
-  - See [the official document](https://github.com/git-lfs/git-lfs/wiki/Installation)
+  - See [the official document](https://github.com/git-lfs/git-lfs/wiki/Installation).
 
 ```sh
 curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.deb.sh | sudo bash
@@ -51,7 +55,7 @@ git lfs install
 curl https://sh.rustup.rs -sSf | sh
 ```
 
-- Install `ml-cellar`
+- Install `ml-cellar`.
 
 ```sh
 cargo install ml-cellar
@@ -72,9 +76,9 @@ cargo install --path .
 
 ### 2. Setup repository
 
-Let's open the cellar for AI models
+Let's open the cellar for AI models.
 
-- Start `ml-cellar`
+- Start `ml-cellar`.
 
 ```sh
 mkdir {your_ml_registry}
@@ -135,13 +139,13 @@ The rack consists of the following directory structure:
 In this directory, we call the ML model like `vit-l 1.1` for "Large size of Vision Transformer, version 1.1".
 It is like vintage wine called by "Dom Pérignon Vintage 2010".
 
-- Make rack
+- Make rack.
 
 ```sh
 ml-cellar rack {path}
 ```
 
-- If you run `ml-cellar rack {my_algorithm}`, then you can see as below
+- If you run `ml-cellar rack {my_algorithm}`, then you can see as below.
   - Without `ml-cellar rack {my_algorithm}` command, you can make rack by making directory and `config.toml` manually.
 
 ```yaml
@@ -152,8 +156,8 @@ ml-cellar rack {path}
     - template.md
 ```
 
-- Edit config.toml
-  - Add required files to save ML registry
+- Edit config.toml.
+  - Add required files to save ML registry.
   - If you allow to save any kind of file, you set `"*"` for optional files.
 
 ```toml
@@ -162,28 +166,28 @@ required_files = ["config.yaml", "logs/"]
 optional_files = ["*"]
 ```
 
-- Edit README.md
+- Edit README.md.
   - When developing ML models as a team, or providing ML models to various projects, a cellar isn’t opened for just one person.
   - Just as with wine, where you introduce its flavor and the foods it pairs well with, let’s write a description of the ML model for users.
 
 ### 5. (Option) Set up projects for MLOps
 
-- Start fine-tuning for projects from base model
+- Start fine-tuning for projects from base model.
 
 If you use fixed dataset and focus on algorithm development like Kaggle competition or research usage, the simple ML cellar is fine to share various experimental results using single rack.
 
 However, if you are an engineer and you have many projects you want to fine-tuning for, I recommend to use "project-based model registry".
-Please see [the document for project-based model registry](docs/project_based_model_registry.md)
+Please see [the document for project-based model registry](docs/project_based_model_registry.md).
 
-- Setup template.md and result.json for MLOps
+- Setup template.md and result.json for MLOps.
 
 If you want to setup template.md and result.json for MLOps, then please see [the document for template.md](docs/docs_template.md).
 
 ### 6. Commit ML model
 
-Let's actually stock AI models on the racks
+Let's actually stock AI models on the racks.
 
-- Make branch and switch the branch
+- Make branch and switch the branch.
 
 ```sh
 git sw -c feat/my_algorithm/0.1
@@ -210,7 +214,7 @@ git sw -c feat/my_algorithm/0.1
 ml-cellar check {path}
 ```
 
-- In this example, please run this command
+- In this example, please run this command.
 
 ```sh
 cd {your_ml_registry}
@@ -224,13 +228,17 @@ git add {path}
 git commit -m "{commit message}"
 ```
 
-- Push the files
+- Push the files.
 
 ```sh
 ml-cellar push
 ```
 
-- Make PR and review
+- Make PR and review.
+  - You can see examples of review as below.
+  - https://github.com/scepter914/ml-cellar-example/pull/2
+  - https://github.com/scepter914/ml-cellar-example/pull/3
+  - https://github.com/scepter914/ml-cellar-example/pull/4
 - After PR merged and if you want to pull the repository, run pull command.
 
 ```sh
@@ -239,28 +247,28 @@ ml-cellar pull
 
 ### 7. Use `ml-cellar` as model serve
 
-A wine cellar is a storage facility, but it's also a facility for serving
+A wine cellar is a storage facility, but it's also a facility for serving.
 
-- Clone repository
-  - At this point, there are only Git LFS references, and the actual files do not exist
+- Clone repository.
+  - At this point, there are only Git LFS references, and the actual files do not exist.
 
 ```sh
 ml-cellar clone {your_ml_registry}
 ```
 
-- Materialize all files
+- Materialize all files.
 
 ```sh
 ml-cellar get-all
 ```
 
-- Materialize a specific directory
+- Materialize a specific directory.
 
 ```sh
 ml-cellar get {path to a directory}
 ```
 
-- Materialize a specific file
+- Materialize a specific file.
 
 ```sh
 ml-cellar get {path to a file}

src/bin/ml-cellar/clone.rs

@@ -0,0 +1,26 @@
+use std::process::{Command, Stdio};
+
+pub fn clone(repository: String) {
+    let status = Command::new("git")
+        .env("GIT_LFS_SKIP_SMUDGE", "1")
+        .arg("clone")
+        .arg(repository)
+        .stdin(Stdio::null())
+        .stdout(Stdio::null())
+        .stderr(Stdio::null())
+        .status();
+
+    match status {
+        Ok(s) if s.success() => {
+            println!("git clone done");
+        }
+        Ok(s) => {
+            eprintln!("git clone failed: {s}");
+            std::process::exit(1);
+        }
+        Err(e) => {
+            eprintln!("failed to execute git: {e}");
+            std::process::exit(1);
+        }
+    }
+}

src/bin/ml-cellar/main.rs

@@ -2,6 +2,7 @@ use clap::{Parser, Subcommand};
 use std::path::PathBuf;
 
 mod check;
+mod clone;
 mod init;
 mod rack;
 
@@ -18,6 +19,11 @@ struct Cli {
 enum Commands {
     /// Initialize a new repository
     Init {},
+    /// Clone an existing repository
+    Clone {
+        /// Repository (URL or path)
+        repository: String,
+    },
     /// Create a new rack at the specified path
     /// "Rack" is a collection of ML models and related files.
     Rack {
@@ -36,6 +42,9 @@ fn main() {
         Commands::Init {} => {
             init::init();
         }
+        Commands::Clone { repository } => {
+            clone::clone(repository);
+        }
         Commands::Rack { path } => {
             rack::rack(path);
         }

tests/fixtures/test_registry/test_check_for_version/config.toml

@@ -9,6 +9,7 @@ optional_files = ["*.png"]
 [project]
 project = ["base", "pretrained", "projectA"]
 version_yyyymmdd = ["pretrained"]
+version_x = []
 version_x_y = ["base"]
 version_x_y_z = ["projectA"]