Recipe serialization

[ljleb]

We want to be able to serialize merge recipes into a human readable and editable format and also deserialize them into instances of MergeRecipe. I was thinking that we could represent a recipe as a simple list in a file with the extension .mecha.

I suggest to consider reducing the contents of the file to a single list of instructions that can be performed to merge:

model "ghostmix_v20Bakedvae"
model "dreamshaper_332BakedVaeClipFix"
call "weighted_sum" &0 &1 alpha=0.5

Here, weighted_sum &0 &1 alpha=0.5 means that weighted_sum has 2 positional arguments: the result of line 0 and the result of line 1; and 1 named parameter: alpha with the float value 0.5.

Each line is an expression. The nth line is associated with the index n. Indices start at 0. The first word in a line is the "operation" to perform (either a merge method, basic actions like loading a model or a lora or even the definition of hyper parameters) followed by n space-sparated words, which are its arguments. The last expression is the final output of the recipe.

To reconstruct a recipe in python from a .mecha, we can simply read it from top to bottom, mapping the first word in a and use a dictionary to keep track of existing nodes. We can then return the last node from this function.

[ljleb]

Disclaimer: the following was generated with GPT4.

Mecha Language Specification Version 1.0

Overview

The Mecha language offers a streamlined syntax for defining model merge operations, enabling users to efficiently describe complex model manipulation and merging processes. It is a line-oriented language where each line encapsulates a distinct expression that resolves to a specific value. This document provides a comprehensive and unambiguous specification of the Mecha language, including its syntax, expression structure, functions, and argument handling.

Syntax Specification

General Structure

• Lines: Each line in a Mecha script represents a unique expression. The end of a line signifies the termination of an expression.
• Expressions: Expressions are structured as a function call followed by its required arguments. An expression is evaluated to produce a value.
• Function Calls: The initial word of an expression identifies the function to be invoked. Functions in Mecha are predefined operations that execute actions or computations based on the arguments supplied.
• Arguments: Arguments to functions can be either positional or keyword arguments, and their values can be of types string, number, or address.
  • Positional Arguments are specified directly after the function name and are separated by spaces. They are identified by their order rather than a name.
  • Keyword Arguments are presented after all positional arguments and are formatted as key=value pairs. A keyword argument's key is separated from its value by an "=" character.
• Value Types:
  • Strings are enclosed within double quotes (e.g., "example").
  • Numbers can be integers, floating-point values, or values in scientific notation without any special delimiters.
  • Addresses reference the results of prior expressions and are denoted by an ampersand (&) followed by an integer index (e.g., &2), indexing expressions by their appearance order, starting from zero.
• String Literals and the Equal Sign: Within string literals, the equal sign (=) is treated as part of the string content, not as a delimiter for keyword arguments.

Detailed Function and Argument Specification

Functions

• Functions represent the core operations within Mecha. Each function is designed to perform a specific task or computation.
• A function call is always expected to return a value, which can be used in subsequent expressions.

Argument Handling

Positional Arguments

• These are the initial set of arguments following the function name, provided in direct sequence without naming.
• Positional arguments are separated by spaces and can represent strings, numbers, or addresses.

Keyword Arguments

• Keyword arguments commence immediately after the last positional argument.
• They are expressed as key=value pairs, allowing for named argument specification.
• Every argument following the introduction of a keyword argument must also be a keyword argument.
• The presence of an equal sign (=) within a quoted string value is interpreted as part of the string content.

Example Usage

Basic Model Invocation

model "ghostmix_v20Bakedvae"
model "dreamshaper_332BakedVaeClipFix"
call "weighted_sum" &0 &1 alpha=0.5

Advanced Model Merge Recipe

model "ghostmix_v20Bakedvae"
model "pure/v1-5-pruned"
call "subtract" &0 &1
model "dreamshaper_332BakedVaeClipFix"
call "subtract" &3 &1
call "perpendicular_component" &2 &4
call "add_difference" &0 &5 alpha=1.0
call "weighted_sum" &0 &3 alpha=0.5
dict txt_class_pos_embed=0 txt_class_token_embed=0 txt_class_final_norm=0 txt_class_layer_norm1=0 txt_class_layer_norm2=0 txt_class_mlp_fc1=0 txt_class_mlp_fc2=0 txt_class_q=0 txt_class_k=0 txt_class_v=0 txt_class_out=0 txt_class_default=0 unet_class_in0=1 unet_class_op=1 unet_class_proj_in=1 unet_class_proj_out=1 unet_class_trans_attn1_q=1 unet_class_trans_attn1_k=1 unet_class_trans_attn1_v=1 unet_class_trans_attn1_out=1 unet_class_trans_attn2_q=1 unet_class_trans_attn2_k=1 unet_class_trans_attn2_v=1 unet_class_trans_attn2_out=1 unet_class_trans_norm1=1 unet_class_trans_norm2=1 unet_class_trans_norm3=1 unet_class_trans_ff_net0_proj=1 unet_class_trans_ff_net2=1 unet_class_emb_layers1=1 unet_class_in_layers0=1 unet_class_in_layers2=1 unet_class_out_layers0=1 unet_class_out_layers3=1 unet_class_norm=1 unet_class_skip_connection=1 unet_class_conv=

1 unet_class_out0=1 unet_class_out2=1 unet_class_default=1
call "weighted_sum" &6 &7 alpha=&8

Additional Remarks

• No Comment Support: The Mecha language syntax does not accommodate comments. Each line within a Mecha script must constitute a valid expression according to the specified syntax.
• Purpose and Design: The design of Mecha emphasizes concise and expressive syntax to support complex model manipulation and merging operations, facilitating the creation of detailed and efficient model merge recipes.