HAT feedback 1/26 #4

masonremy · 2021-01-27T06:20:04Z

No description provided.

masonremy · 2021-01-27T19:18:54Z

README.md


-A library in the HAT format typically includes one `.lib` file and one or more `.hat` files. The `.lib` file contains all the compiled object code that implements the library functions. Each `.hat` file contains a combination of standard C function declarations (like a typical `.h` file) and metadata in the TOML markup language. The metadata that accompanies each function declaration describes how the function should be called and how it was implemented. The metadata is intended to be both human-readable and machine-readable, providing structured and systematic documentation and allowing downstream tools to examine the library contents. 
+A library in the HAT format typically includes one static library file (`.a` or `.lib`) and one or more `.hat` files. The static library contains all the compiled object code that implements the library functions. Each `.hat` file contains a combination of standard C function declarations (like a typical `.h` file) and metadata in the TOML markup language. The metadata that accompanies each function declaration describes how the function should be called and how it was implemented. The metadata is intended to be both human-readable and machine-readable, providing structured and systematic documentation and allowing downstream tools to examine the library contents. 


delineate the 4 possibilities - { Windows, Posix } x { static, dynamic } - give specifics about Windows vs Posix and static vs dynamic. Core concept is all the implementations are in one place.

"hat library" -> "hat package" everywhere

machine code file

binary code file

?

with static libraries, the C runtime library used is also important. architecture is also important, but for different reasons between posix and windows.

these ideas get encapsulated in the "required" and "dependencies" sections of the schema, do you think they should be discussed more in the README?

masonremy · 2021-01-27T19:19:48Z

README.md

@@ -2,9 +2,9 @@

 # HAT file format

-HAT is a format for distributing compiled libraries in the C programming language. HAT stands for "h-file Annotated with Toml", and implies that standard C header files are decorated with useful metadata in the [TOML](https://toml.io/) markup language. 
+HAT is a format for distributing compiled libraries in the C programming language. HAT stands for "C **H**eader **A**nnotated with **T**OML", and implies that standard C header files are decorated with useful metadata in the [TOML](https://toml.io/) markup language.


drop the "C" in the acronym expansion

masonremy · 2021-01-27T19:25:07Z

samples/sample_gemm_library.hat

@@ -5,15 +5,19 @@ comment = "Automatically generated by the RoboCode compiler"
 author = "John Doe"
 version = "1.2.3.5"
 license_url = "https://www.apache.org/licenses/LICENSE-2.0.html"
+library_name = "sample_gemm.lib"
+library_md5 = "ABCD1234..."


doesn't address windows dynamic case appropriately.

unnecessary if the function names are unique - not part of HAT specification

all function names HAVE to be unique if this is a C header.

sorry, my comment didn't have the necessary context - unique here is in the context of a single function over the course of multiple re-generations of the package. If the function names are given a new GUID every time the package is generated then the package doesn't need any further identifying information since the name of the function is strongly tied to the instance of the generated package, but if the names are constant over multiple re-generations then the producer and consumer of the HAT package need to determine for themselves whether the .hat file and the associated library file are in sync

masonremy · 2021-01-27T19:28:51Z

samples/sample_gemm_library.hat

@@ -5,15 +5,19 @@ comment = "Automatically generated by the RoboCode compiler"
 author = "John Doe"
 version = "1.2.3.5"
 license_url = "https://www.apache.org/licenses/LICENSE-2.0.html"
+library_name = "sample_gemm.lib"


move to dependencies, name it something more specific indicating that this is the file to link against. Also include reference to dll or other files to deploy

'link_target'

if we're talking about deployment scenarios, in windows you also need to deploy additional files (like .manifest files)

yeah, i added that as a "deploy_files" field. I was mostly thinking of it in the context of .dll files, but manifest files (and surely there are others) are another good example

masonremy · 2021-01-27T19:31:30Z

schema/hat.tosd

+        # The calling convention for this function
+        [types.functionType.calling_convention]
+        type = "string"
+        allowedvalues = [ "__stdcall", "__cdecl", "__fastcall", "__vectorcall" ]


remove leading underscores

masonremy · 2021-01-27T19:35:31Z

samples/sample_gemm_library.hat


 [functions]
    [functions.GEMM_B94D27B9934D3E08]
    name = "GEMM_B94D27B9934D3E08"
    description = "CPU Implementation of the GEMM algorithm: C = alpha * (A * B) + beta * C with specific sizes."
+    calling_convention = "__stdcall"
+    can_assert = false


can't enforce this in C so we can't guarantee that downstream components also hold to this.
change values to "true" vs "unknown" ?

remove can_assert, take as an action item for hat vnext:

how do we add a sound/complete set of constraints and validity checks on arguments.

can_assert vs "is_checked" vs "can_be_null" etc on individual arguments

masonremy · 2021-01-27T19:37:52Z

samples/sample_gemm_library.hat

-        { name = "A", description = "left-hand input matrix", logical_type = "affine_array", declared_type = "const float*", element_type = "float", usage = "input", layout = { affine_array = { shape = [ 512, 256 ], affine_map = [ 256, 1 ], affine_offset = 0 } } },
-        { name = "B", description = "right-hand input matrix", logical_type = "affine_array", declared_type = "const float*", element_type = "float", usage = "input", layout = { affine_array = { shape = [ 256, 512 ], affine_map = [ 512, 1 ], affine_offset = 0 } } },
-        { name = "C", description = "result accumulation matrix", logical_type = "affine_array", declared_type = "float*", element_type = "float", usage = "input_output", layout = { affine_array = { shape = [ 512, 512 ], affine_map = [ 512, 1 ], affine_offset = 0 } } },
+        { name = "A", description = "left-hand input matrix", logical_type = "affine_array", declared_type = "const float*", element_type = "float", usage = "input", shape = [ 512, 256 ], affine_map = [ 256, 1 ], affine_offset = 0 },


hat validator confirming collection of optional keys

(hat TOML schema validator + hat package/library second tier validator that is common utility code provided as part of general hat repo)

masonremy · 2021-01-27T19:39:56Z

schema/hat.tosd

@@ -290,9 +292,10 @@ version = "0.0.0.1"
                type = "table"
                optional = true


add gpu cache section, action item to account for controllable L1 vs shared memory

masonremy · 2021-01-27T19:46:19Z

samples/sample_gemm_library.hat

-        l1_KB = 32
-        l2_KB = 256
-        l3_KB = 56320
+        sizes_KB = [ 32, 256, 56320 ]


(for gpu) : max_sizes_KB to address scalable L1 vs shared memory case?

continue discussion - is specific hardware target vs hardware characteristics the best option?

some users can use specific hardware, but some HAT users might not

masonremy · 2021-01-27T19:49:05Z

samples/sample_gemm_library.hat

-        l2_KB = 256
-        l3_KB = 56320
+        sizes_KB = [ 32, 256, 56320 ]
+        line_sizes = [ 64, 64, 64 ]

 [dependencies]


make notes in samples and schema discussing the difference between dependencies and compiled_with

kernhanda and others added 4 commits January 20, 2021 17:19

Update README.md

b538b91

Update README.md

528061f

Incorporating review feedback from teams discussions

fc8a87a

Incorporate Kern's readme feedback

ed5bc01

masonremy changed the title ~~Dev/masonremy/hat feedback update 1 26~~ HAT feedback 1/26 Jan 27, 2021

masonremy commented Jan 27, 2021

View reviewed changes

Incorporate discussion feedback

cdb4305

masonremy merged commit 00f21bc into main Jan 27, 2021

lisaong deleted the dev/masonremy/hat_feedback_update_1_26 branch January 5, 2022 07:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

HAT feedback 1/26 #4

HAT feedback 1/26 #4

masonremy commented Jan 27, 2021

masonremy Jan 27, 2021

kernhanda Jan 28, 2021

masonremy Jan 28, 2021

masonremy Jan 27, 2021

masonremy Jan 27, 2021

masonremy Jan 27, 2021

kernhanda Jan 28, 2021

masonremy Jan 28, 2021

masonremy Jan 27, 2021

kernhanda Jan 28, 2021

masonremy Jan 28, 2021

masonremy Jan 27, 2021

masonremy Jan 27, 2021

masonremy Jan 27, 2021

masonremy Jan 27, 2021

masonremy Jan 27, 2021

masonremy Jan 27, 2021

masonremy Jan 27, 2021 •

edited

Loading

masonremy Jan 27, 2021


		A library in the HAT format typically includes one `.lib` file and one or more `.hat` files. The `.lib` file contains all the compiled object code that implements the library functions. Each `.hat` file contains a combination of standard C function declarations (like a typical `.h` file) and metadata in the TOML markup language. The metadata that accompanies each function declaration describes how the function should be called and how it was implemented. The metadata is intended to be both human-readable and machine-readable, providing structured and systematic documentation and allowing downstream tools to examine the library contents.
		A library in the HAT format typically includes one static library file (`.a` or `.lib`) and one or more `.hat` files. The static library contains all the compiled object code that implements the library functions. Each `.hat` file contains a combination of standard C function declarations (like a typical `.h` file) and metadata in the TOML markup language. The metadata that accompanies each function declaration describes how the function should be called and how it was implemented. The metadata is intended to be both human-readable and machine-readable, providing structured and systematic documentation and allowing downstream tools to examine the library contents.

		@@ -290,9 +292,10 @@ version = "0.0.0.1"
		type = "table"
		optional = true

HAT feedback 1/26 #4

HAT feedback 1/26 #4

Conversation

masonremy commented Jan 27, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

masonremy Jan 27, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

masonremy Jan 27, 2021 •

edited

Loading