---
title: 'Input Formats'
url: 'https://timeloop.csail.mit.edu/previous_versions/timeloop-accelergy-v3/timeloop/input-formats'
markdown: 'https://timeloop.csail.mit.edu/previous_versions/timeloop-accelergy-v3/timeloop/input-formats.md'
date: '2024-08-15'
description: 'Both timeloop-model and timeloop-mapper take inputs in the form of a YAML file with specific top-level keys. These top-level keys may be included in one or more files (one or more top-level keys per file) that are concatenated together by the tool. Some keys are used only for one of the programs …'
taxonomy:
  category:
    - docs
---

[](#)  [ Overview ](https://timeloop.csail.mit.edu/)     [ Previous Versions ](https://timeloop.csail.mit.edu/previous_versions)     [ Timeloop+Accelergy v3 ](https://timeloop.csail.mit.edu/previous_versions/timeloop-accelergy-v3)     [ Timeloop ](https://timeloop.csail.mit.edu/previous_versions/timeloop-accelergy-v3/timeloop)      Input Formats    

# Input Formats

Both `timeloop-model` and `timeloop-mapper` take inputs in the form of a YAML file with specific top-level keys. These top-level keys may be included in one or more files (one or more top-level keys per file) that are concatenated together by the tool.

Some keys are used only for one of the programs or are optional. So a skeleton input with the top-level keys for a run of `timeloop-mapper` would look like:

```yaml
problem:
    ...

architecture:
    ...

sparse_optimizations:
    ...

contraints:
   ....

mapper:
   ....
```

Each top-level key is described in its own section:

- [Problem](https://timeloop.csail.mit.edu/previous_versions/timeloop-accelergy-v3/timeloop/input-formats/./problem) - The tensor computation to be performed
- [Design](https://timeloop.csail.mit.edu/previous_versions/timeloop-accelergy-v3/timeloop/input-formats/./design) - Not actually a key itself, but a collection of three keys that collectively describe the design 
    - [Architecture](https://timeloop.csail.mit.edu/previous_versions/timeloop-accelergy-v3/timeloop/input-formats/./design/architecture) - A hierarchical specification of the hardware architecture
    - [Sparse Optimizations](https://timeloop.csail.mit.edu/previous_versions/timeloop-accelergy-v3/timeloop/input-formats/./design/sparse-optimizations) - A specification of the optimizations designed to exploit sparsity (optional)
    - [Constraints](https://timeloop.csail.mit.edu/previous_versions/timeloop-accelergy-v3/timeloop/input-formats/./design/constraints) - Constraints on legal mappings (optional)

Additionally, timeloop-model needs the following input:

- [Mapping](https://timeloop.csail.mit.edu/previous_versions/timeloop-accelergy-v3/timeloop/input-formats/./mapping) - A mapping of the problem on to the hardware

Timeloop-mapper needs the following additional input:

- [Mapper](https://timeloop.csail.mit.edu/previous_versions/timeloop-accelergy-v3/timeloop/input-formats/./mapper) - Directives to control the behavior of the mapping search

[accessibility](https://accessibility.mit.edu/)

 [ ](https://timeloop.csail.mit.edu/previous_versions/timeloop-accelergy-v3/timeloop/command-line) [](https://timeloop.csail.mit.edu/previous_versions/timeloop-accelergy-v3/timeloop/input-formats/problem)

---

## Navigation

- Parent: [Timeloop](https://timeloop.csail.mit.edu/previous_versions/timeloop-accelergy-v3/timeloop.md)
- Previous: [Command Line](https://timeloop.csail.mit.edu/previous_versions/timeloop-accelergy-v3/timeloop/command-line.md)
- Next: [Output Formats](https://timeloop.csail.mit.edu/previous_versions/timeloop-accelergy-v3/timeloop/output-formats.md)
- Children:
  - [Problem](https://timeloop.csail.mit.edu/previous_versions/timeloop-accelergy-v3/timeloop/input-formats/problem.md)
  - [Design](https://timeloop.csail.mit.edu/previous_versions/timeloop-accelergy-v3/timeloop/input-formats/design.md)
  - [Mapping](https://timeloop.csail.mit.edu/previous_versions/timeloop-accelergy-v3/timeloop/input-formats/mapping.md)
  - [Mapper](https://timeloop.csail.mit.edu/previous_versions/timeloop-accelergy-v3/timeloop/input-formats/mapper.md)
