modelcards 0.1.4

A fast modelcard generator with built-in templates
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

use std::path::PathBuf;

use clap::{Parser, Subcommand};
use clap_complete::Shell;
use clap_verbosity_flag::Verbosity;

#[derive(Parser)]
#[clap(version, author, about)]
pub struct Cli {
    /// Directory to use as root of project
    #[clap(short = 'r', long, default_value = ".")]
    pub root: PathBuf,

    /// Path to a config file other than config.toml in the root of project
    #[clap(short = 'c', long, default_value = "config.toml")]
    pub config: PathBuf,

    #[command(flatten)]
    pub verbose: Verbosity,

    #[clap(subcommand)]
    pub command: Command,
}

#[derive(Subcommand)]
pub enum Command {
    /// Create a new modelcard project
    Init {
        /// Name of the project. Will create a new directory with that name in the current directory
        #[clap(default_value = ".")]
        name: String,

        /// Force creation of project even if directory is non-empty
        #[clap(short = 'f', long)]
        force: bool,
    },

    /// Deletes the output directory if there is one and builds the modelcard
    Build {
        /// The source modelcard data file to be build (defaults to all in 'data' dir in project root)
        #[clap(short = 's', long)]
        source: Option<String>,

        /// Outputs the generated site in the given path (by default 'card' dir in project root)
        #[clap(short = 'o', long)]
        target: Option<String>,

        /// Force building the modelcard even if output directory is non-empty
        #[clap(short = 'f', long)]
        force: Option<bool>,
    },

    /// Try to build the project without rendering it. Checks inputs
    Check {
        /// The source modelcard data file to be verified (defaults to sample.json or settings in config.toml)
        #[clap(short = 's', long)]
        source: Option<String>,
    },

    /// Validate the modelcard data file against the schema
    Validate {
        /// The source modelcard data file to be verified
        #[clap(value_delimiter = ' ', num_args = 1..)]
        sources: Vec<String>,

        /// The schema file to validate against (defaults to build-in schema)
        #[clap(short = 's', long)]
        schema: Option<String>,
    },

    /// Render the modelcard using template
    Render {
        /// The source modelcard data file to be verified
        #[clap(value_delimiter = ' ', num_args = 1..)]
        sources: Vec<String>,

        /// The jinjia template file to use (defaults to build-in markdown template)
        #[clap(short = 't', long)]
        template: Option<String>,
    },

    /// Merge multiple modelcard data files into one
    Merge {
        /// The source modelcard data files to be merged
        #[clap(value_delimiter = ' ', num_args = 1..)]
        sources: Vec<String>,

        /// The output file to write the merged data to
        #[clap(short = 'o', long)]
        target: Option<String>,
    },

    /// Generate shell completion
    Completion {
        /// Shell to generate completion for
        #[clap(value_enum)]
        shell: Shell,
    },
}