Instructions to use nvidia/Cosmos3-Edge with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Cosmos
How to use nvidia/Cosmos3-Edge with Cosmos:
# No code snippets available yet for this library. # To use this model, check the repository files and the library's documentation. # Want to help? PRs adding snippets are welcome at: # https://github.com/huggingface/huggingface.js
- Notebooks
- Google Colab
- Kaggle
| {% macro render_extra_keys(json_dict, handled_keys) %} | |
| {%- if json_dict is mapping %} | |
| {%- for json_key in json_dict if json_key not in handled_keys %} | |
| {%- if json_dict[json_key] is mapping or (json_dict[json_key] is sequence and json_dict[json_key] is not string) %} | |
| {{- ' | |
| <' ~ json_key ~ '>' ~ (json_dict[json_key] | tojson | safe) ~ '</' ~ json_key ~ '>' }} | |
| {%- else %} | |
| {{-' | |
| <' ~ json_key ~ '>' ~ (json_dict[json_key] | string) ~ '</' ~ json_key ~ '>' }} | |
| {%- endif %} | |
| {%- endfor %} | |
| {%- endif %} | |
| {% endmacro %} | |
| {%- set enable_thinking = enable_thinking if enable_thinking is defined else True %} | |
| {%- set truncate_history_thinking = truncate_history_thinking if truncate_history_thinking is defined else True %} | |
| {%- set ns = namespace(last_user_idx = -1) %} | |
| {%- set loop_messages = messages %} | |
| {%- for m in loop_messages %} | |
| {%- if m["role"] == "user" %} | |
| {%- set ns.last_user_idx = loop.index0 %} | |
| {%- endif %} | |
| {%- endfor %} | |
| {%- if messages[0]["role"] == "system" %} | |
| {%- if messages[0]["content"] is string %} | |
| {%- set system_message = messages[0]["content"] %} | |
| {%- else %} | |
| {%- set ns = namespace(system_text="") %} | |
| {%- for part in messages[0]["content"] %} | |
| {%- if 'text' in part %} | |
| {%- set ns.system_text = ns.system_text + part.text %} | |
| {%- endif %} | |
| {%- endfor %} | |
| {%- set system_message = ns.system_text %} | |
| {%- endif %} | |
| {%- set loop_messages = messages[1:] %} | |
| {%- else %} | |
| {%- set system_message = "" %} | |
| {%- set loop_messages = messages %} | |
| {%- endif %} | |
| {%- if not tools is defined %} | |
| {%- set tools = [] %} | |
| {%- endif %} | |
| {# Recompute last_user_idx relative to loop_messages after handling system #} | |
| {%- set ns = namespace(last_user_idx = -1) %} | |
| {%- for m in loop_messages %} | |
| {%- if m["role"] == "user" %} | |
| {%- set ns.last_user_idx = loop.index0 %} | |
| {%- endif %} | |
| {%- endfor %} | |
| {%- if system_message is defined %} | |
| {{- "<|im_start|>system | |
| " + system_message }} | |
| {%- else %} | |
| {%- if tools is iterable and tools | length > 0 %} | |
| {{- "<|im_start|>system | |
| " }} | |
| {%- endif %} | |
| {%- endif %} | |
| {%- if tools is iterable and tools | length > 0 %} | |
| {%- if system_message is defined and system_message | length > 0 %} | |
| {{- " | |
| " }} | |
| {%- endif %} | |
| {{- "# Tools | |
| You have access to the following functions: | |
| " }} | |
| {{- "<tools>" }} | |
| {%- for tool in tools %} | |
| {%- if tool.function is defined %} | |
| {%- set tool = tool.function %} | |
| {%- endif %} | |
| {{- " | |
| <function> | |
| <name>" ~ tool.name ~ "</name>" }} | |
| {%- if tool.description is defined %} | |
| {{- ' | |
| <description>' ~ (tool.description | trim) ~ '</description>' }} | |
| {%- endif %} | |
| {{- ' | |
| <parameters>' }} | |
| {%- if tool.parameters is defined and tool.parameters is mapping and tool.parameters.properties is defined and tool.parameters.properties is mapping %} | |
| {%- for param_name, param_fields in tool.parameters.properties|items %} | |
| {{- ' | |
| <parameter>' }} | |
| {{- ' | |
| <name>' ~ param_name ~ '</name>' }} | |
| {%- if param_fields.type is defined %} | |
| {{- ' | |
| <type>' ~ (param_fields.type | string) ~ '</type>' }} | |
| {%- endif %} | |
| {%- if param_fields.description is defined %} | |
| {{- ' | |
| <description>' ~ (param_fields.description | trim) ~ '</description>' }} | |
| {%- endif %} | |
| {%- if param_fields.enum is defined %} | |
| {{- ' | |
| <enum>' ~ (param_fields.enum | tojson | safe) ~ '</enum>' }} | |
| {%- endif %} | |
| {%- set handled_keys = ['name', 'type', 'description', 'enum'] %} | |
| {{- render_extra_keys(param_fields, handled_keys) }} | |
| {{- ' | |
| </parameter>' }} | |
| {%- endfor %} | |
| {%- endif %} | |
| {% set handled_keys = ['type', 'properties', 'required'] %} | |
| {{- render_extra_keys(tool.parameters, handled_keys) }} | |
| {%- if tool.parameters is defined and tool.parameters.required is defined %} | |
| {{- ' | |
| <required>' ~ (tool.parameters.required | tojson | safe) ~ '</required>' }} | |
| {%- endif %} | |
| {{- ' | |
| </parameters>' }} | |
| {%- set handled_keys = ['type', 'name', 'description', 'parameters'] %} | |
| {{- render_extra_keys(tool, handled_keys) }} | |
| {{- ' | |
| </function>' }} | |
| {%- endfor %} | |
| {{- " | |
| </tools>" }} | |
| {{- ' | |
| If you choose to call a function ONLY reply in the following format with NO suffix: | |
| <tool_call> | |
| <function=example_function_name> | |
| <parameter=example_parameter_1> | |
| value_1 | |
| </parameter> | |
| <parameter=example_parameter_2> | |
| This is the value for the second parameter | |
| that can span | |
| multiple lines | |
| </parameter> | |
| </function> | |
| </tool_call> | |
| <IMPORTANT> | |
| Reminder: | |
| - Function calls MUST follow the specified format: an inner <function=...></function> block must be nested within <tool_call></tool_call> XML tags | |
| - Required parameters MUST be specified | |
| - You may provide optional reasoning for your function call in natural language BEFORE the function call, but NOT after | |
| - If there is no function call available, answer the question like normal with your current knowledge and do not tell the user about function calls | |
| </IMPORTANT>' }} | |
| {%- endif %} | |
| {%- if system_message is defined %} | |
| {{- '<|im_end|> | |
| ' }} | |
| {%- else %} | |
| {%- if tools is iterable and tools | length > 0 %} | |
| {{- '<|im_end|> | |
| ' }} | |
| {%- endif %} | |
| {%- endif %} | |
| {%- set image_count = namespace(value=0) %} | |
| {%- set video_count = namespace(value=0) %} | |
| {%- for message in loop_messages %} | |
| {%- if message.role == "assistant" %} | |
| {# Add reasoning content in to content field for unified processing below. #} | |
| {%- set text_content = namespace(text_content="") -%} | |
| {%- if message.content is string %} | |
| {%- set text_content.text_content = message.content %} | |
| {%- else %} | |
| {%- for content in message.content %} | |
| {%- if 'text' in content %} | |
| {%- set text_content.text_content = content.text %} | |
| {%- break %} | |
| {%- endif %} | |
| {%- endfor %} | |
| {%- endif %} | |
| {%- if message.reasoning_content is defined and message.reasoning_content is string and message.reasoning_content | trim | length > 0 %} | |
| {%- set content = "<think> | |
| " ~ message.reasoning_content ~ " | |
| </think> | |
| " ~ (text_content.text_content | default('', true)) %} | |
| {%- else %} | |
| {%- set content = text_content.text_content | default('', true) %} | |
| {# Allow downstream logic to to take care of broken thought, only handle coherent reasoning here. #} | |
| {%- if '<think>' not in content and '</think>' not in content %} | |
| {%- set content = "<think></think>" ~ content %} | |
| {%- else %} | |
| {%- set content = content %} | |
| {%- endif -%} | |
| {%- endif %} | |
| {%- if message.tool_calls is defined and message.tool_calls is iterable and message.tool_calls | length > 0 %} | |
| {# Assistant message has tool calls. #} | |
| {{- '<|im_start|>assistant | |
| ' }} | |
| {%- set include_content = not (truncate_history_thinking and loop.index0 < ns.last_user_idx) %} | |
| {%- if content is string and content | trim | length > 0 %} | |
| {%- if include_content %} | |
| {{- (content | trim) ~ ' | |
| ' -}} | |
| {%- else %} | |
| {%- set c = (content | string) %} | |
| {%- if '</think>' in c %} | |
| {# Keep only content after the last closing think. Also generation prompt causes this. #} | |
| {%- set c = c.split('</think>')[-1] %} | |
| {%- elif '<think>' in c %} | |
| {# If <think> was opened but never closed, drop the trailing think segment #} | |
| {%- set c = c.split('<think>')[0] %} | |
| {%- endif %} | |
| {%- set c = "<think></think>" ~ c | trim %} | |
| {%- if c | length > 0 %} | |
| {{- c ~ ' | |
| ' -}} | |
| {%- endif %} | |
| {%- endif %} | |
| {%- else %} | |
| {{- "<think></think>" -}} | |
| {%- endif %} | |
| {%- for tool_call in message.tool_calls %} | |
| {%- if tool_call.function is defined %} | |
| {%- set tool_call = tool_call.function %} | |
| {%- endif %} | |
| {{- '<tool_call> | |
| <function=' ~ tool_call.name ~ '> | |
| ' -}} | |
| {%- if tool_call.arguments is defined %} | |
| {%- for args_name, args_value in tool_call.arguments|items %} | |
| {{- '<parameter=' ~ args_name ~ '> | |
| ' -}} | |
| {%- set args_value = args_value | tojson | safe if args_value is mapping or (args_value is sequence and args_value is not string) else args_value | string %} | |
| {{- args_value ~ ' | |
| </parameter> | |
| ' -}} | |
| {%- endfor %} | |
| {%- endif %} | |
| {{- '</function> | |
| </tool_call> | |
| ' -}} | |
| {%- endfor %} | |
| {{- '<|im_end|> | |
| ' }} | |
| {%- else %} | |
| {# Assistant message doesn't have tool calls. #} | |
| {%- if not (truncate_history_thinking and loop.index0 < ns.last_user_idx) %} | |
| {{- '<|im_start|>assistant | |
| ' ~ (content | default('', true) | string | trim) ~ '<|im_end|> | |
| ' }} | |
| {%- else %} | |
| {%- set c = (content | default('', true) | string) %} | |
| {%- if '<think>' in c and '</think>' in c %} | |
| {%- set c = "<think></think>" ~ c.split('</think>')[-1] %} | |
| {%- endif %} | |
| {%- set c = c | trim %} | |
| {%- if c | length > 0 %} | |
| {{- '<|im_start|>assistant | |
| ' ~ c ~ '<|im_end|> | |
| ' }} | |
| {%- else %} | |
| {{- '<|im_start|>assistant | |
| <|im_end|> | |
| ' }} | |
| {%- endif %} | |
| {%- endif %} | |
| {%- endif %} | |
| {%- elif message.role == "user" or message.role == "system" %} | |
| {{- '<|im_start|>' + message.role + ' | |
| ' }} | |
| {%- if message.content is string %} | |
| {{- message.content }} | |
| {%- else %} | |
| {%- for content in message.content %} | |
| {%- if content.type == 'image' or 'image' in content or 'image_url' in content %} | |
| {%- set image_count.value = image_count.value + 1 %} | |
| {%- if add_vision_id %}Picture {{ image_count.value }}: {% endif -%} | |
| <|vision_start|><|image_pad|><|vision_end|> | |
| {%- elif content.type == 'video' or 'video' in content %} | |
| {%- set video_count.value = video_count.value + 1 %} | |
| {%- if add_vision_id %}Video {{ video_count.value }}: {% endif -%} | |
| <|vision_start|><|video_pad|><|vision_end|> | |
| {%- elif 'text' in content %} | |
| {{- content.text }} | |
| {%- endif %} | |
| {%- endfor %} | |
| {%- endif %} | |
| {{- '<|im_end|> | |
| ' }} | |
| {%- elif message.role == "tool" %} | |
| {%- if loop.previtem and loop.previtem.role != "tool" %} | |
| {{- '<|im_start|>user | |
| ' }} | |
| {%- endif %} | |
| {{- '<tool_response> | |
| ' }} | |
| {{- message.content }} | |
| {{- ' | |
| </tool_response> | |
| ' }} | |
| {%- if not loop.last and loop.nextitem.role != "tool" %} | |
| {{- '<|im_end|> | |
| ' }} | |
| {%- elif loop.last %} | |
| {{- '<|im_end|> | |
| ' }} | |
| {%- endif %} | |
| {%- else %} | |
| {{- '<|im_start|>' + message.role + ' | |
| ' + message.content + '<|im_end|> | |
| ' }} | |
| {%- endif %} | |
| {%- endfor %} | |
| {%- if add_generation_prompt %} | |
| {%- if enable_thinking %} | |
| {{- '<|im_start|>assistant | |
| <think> | |
| ' }} | |
| {%- else %} | |
| {{- '<|im_start|>assistant | |
| <think></think>' }} | |
| {%- endif %} | |
| {%- endif %} |