Commit 9e99bc51 authored by Jens Korinth's avatar Jens Korinth

Closes #10 - Examples for Json syntax of Jobs

* new object JobExamples contains examples and dump code
* can be used to re-generate directly from the defs
* also added a README.md to mark optional/mandatory params
parent c1de1ee9
{
"Job" : "BulkImport",
"CSV" : "some.csv"
}
\ No newline at end of file
{
"Job" : "Compose",
"Composition" : {
"Description" : "An optional description.",
"Composition" : [ {
"Kernel" : "counter",
"Count" : 42
}, {
"Kernel" : "k2",
"Count" : 42
} ]
},
"Design Frequency" : 123,
"Implementation" : "Vivado",
"Architectures" : [ "baseline" ],
"Platforms" : [ "pynq", "zedboard" ],
"DebugMode" : "r"
}
\ No newline at end of file
{
"Job" : "CoreStatistics",
"File Prefix" : "somePrefix_",
"Architectures" : [ "baseline" ],
"Platforms" : [ "vc709", "zc706" ]
}
\ No newline at end of file
{
"Job" : "DesignSpaceExploration",
"Initial Composition" : {
"Description" : "An optional description.",
"Composition" : [ {
"Kernel" : "counter",
"Count" : 42
}, {
"Kernel" : "k2",
"Count" : 42
} ]
},
"Initial Frequency" : 123,
"Dimensions" : {
"Frequency" : true,
"Utilization" : true,
"Alternatives" : false
},
"Heuristic" : "Job Throughput",
"Batch Size" : 16,
"Output Path" : "nonstandard/base/path",
"Architectures" : [ "baseline" ],
"Platforms" : [ "pynq", "vc709" ],
"DebugMode" : "r"
}
\ No newline at end of file
{
"Job" : "HighLevelSynthesis",
"Implementation" : "VivadoHLS",
"Architectures" : [ "baseline" ],
"Platforms" : [ "zedboard", "zc706" ],
"Kernels" : [ "counter", "arraysum" ]
}
\ No newline at end of file
{
"Job" : "Import",
"Zip" : "path/to/ipxact-archive.zip",
"Id" : 42,
"Description" : "Optional description of the core.",
"Average Clock Cycles" : 13124425,
"Architectures" : [ "baseline" ],
"Platforms" : [ "zedboard", "zc706" ]
}
\ No newline at end of file
[ {
"Job" : "BulkImport",
"CSV" : "some.csv"
}, {
"Job" : "Compose",
"Composition" : {
"Description" : "An optional description.",
"Composition" : [ {
"Kernel" : "counter",
"Count" : 42
}, {
"Kernel" : "k2",
"Count" : 42
} ]
},
"Design Frequency" : 123,
"Implementation" : "Vivado",
"Architectures" : [ "baseline" ],
"Platforms" : [ "pynq", "zedboard" ],
"DebugMode" : "r"
}, {
"Job" : "CoreStatistics",
"File Prefix" : "somePrefix_",
"Architectures" : [ "baseline" ],
"Platforms" : [ "vc709", "zc706" ]
}, {
"Job" : "DesignSpaceExploration",
"Initial Composition" : {
"Description" : "An optional description.",
"Composition" : [ {
"Kernel" : "counter",
"Count" : 42
}, {
"Kernel" : "k2",
"Count" : 42
} ]
},
"Initial Frequency" : 123,
"Dimensions" : {
"Frequency" : true,
"Utilization" : true,
"Alternatives" : false
},
"Heuristic" : "Job Throughput",
"Batch Size" : 16,
"Output Path" : "nonstandard/base/path",
"Architectures" : [ "baseline" ],
"Platforms" : [ "pynq", "vc709" ],
"DebugMode" : "r"
}, {
"Job" : "HighLevelSynthesis",
"Implementation" : "VivadoHLS",
"Architectures" : [ "baseline" ],
"Platforms" : [ "zedboard", "zc706" ],
"Kernels" : [ "counter", "arraysum" ]
}, {
"Job" : "Import",
"Zip" : "path/to/ipxact-archive.zip",
"Id" : 42,
"Description" : "Optional description of the core.",
"Average Clock Cycles" : 13124425,
"Architectures" : [ "baseline" ],
"Platforms" : [ "zedboard", "zc706" ]
} ]
\ No newline at end of file
TaPaSCo Jobs Json Formats
=========================
This directory contains an example for each kind of job in TaPaSCo.
`Jobs.json` gives an example for the syntax of a Jobs file, which
can be directly input via `tapasco --jobsFile <FILE>`.
In the following, each parameter is marked with mandatory or
optional: Optional parameters can simply be omitted in the Json.
The `Job` property is mandatory for all jobs.
BulkImportJob
-------------
+ `CSV` - mandatory
ComposeJob
----------
+ `Composition` - mandatory
+ `Composition.Description` - optional
+ `Composition.Composition` - mandatory
+ `Design Frequency` - mandatory
+ `Implementation` - optional (default: "Vivado")
+ `Architectures` - optional (default: all)
+ `Platforms` - optional (default: all)
+ `DebugMode` - optional
CoreStatisticsJob
-----------------
+ `File Prefix` - optional
+ `Architectures` - optional
+ `Platforms` - optional
DesignSpaceExplorationJob
-------------------------
+ `Initial Composition` - mandatory
+ `Initial Frequency` - mandatory if `Dimensions.Frequency` is not `true`
+ `Dimensions` - mandatory
+ `Dimensions.Frequency` - mandatory
+ `Dimensions.Utilization` - mandatory
+ `Dimensions.Alternatives` - mandatory
+ `Heuristic` - optional (default: "job throughput")
+ `Batch Size` - mandatory
+ `Output Path` - optional
+ `Architectures` - optional
+ `Platforms` - optional
+ `DebugMode` - optional
HighLevelSynthesisJob
---------------------
+ `Implementation` - optional (default: "VivadoHLS")
+ `Architectures` - optional (default: all)
+ `Platforms` - optional (default: all)
+ `Kernels` - optional (default: all)
ImportJob
---------
+ `Zip` - mandatory
+ `Id` - mandatory
+ `Description` - optional
+ `Average Clock Cycles` - optional (default: 1)
+ `Architectures` - optional (default: all)
+ `Platforms` - optional (default: all)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment