Struct DocumentConfig 

pub struct DocumentConfig {
    pub template_file: Option<String>,
    pub result_file: Option<String>,
}

Configuration for documentation generation.

Specifies template and result files used for automatically generating documentation for ML-bins.

Fields

template_file: Option<String>

The template file for documentation generation. If you set template_file = “template.md” in config.toml for rack “my_rack”, the structure is as follows:

• model_registry_repository/
  • {rack_name}/
    • template.md
    • config.toml
    • 0.1/
    • 0.2/

result_file: Option<String>

The result file for documentation generation in each version directory. For now, only JSON format is supported. If you set result_file = “result.json” in config.toml for rack “my_rack”, the structure is as follows:

• model_registry_repository/
  • {rack_name}/
    • template.md
    • config.toml
    • 0.1/
      • result.json
    • 0.2/
      • result.json

Trait Implementations

impl Debug for DocumentConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DocumentConfig

fn default() -> DocumentConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocumentConfig

where DocumentConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DocumentConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.