From fdf975eef22f1c0d0eb50928d022a9fbfc145b60 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fran=C3=A7ois=20Bobot?= <francois.bobot@cea.fr>
Date: Mon, 8 Apr 2024 13:39:34 +0200
Subject: [PATCH] Some documentation

---
 lib/ir/nier_simple.mli | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/lib/ir/nier_simple.mli b/lib/ir/nier_simple.mli
index f8ed9f1..1824367 100644
--- a/lib/ir/nier_simple.mli
+++ b/lib/ir/nier_simple.mli
@@ -11,6 +11,7 @@ module Shape : sig
   val set : t -> int -> int -> t
   val row_major : t -> int array -> int
   val unrow_major : t -> int -> int array
+
 end
 
 module Tensor : sig
@@ -129,7 +130,7 @@ type descr =
   | Log of { input : node }
 
 and node = private {
-  id : int;
+  id : int; (* unique identifier *)
   descr : descr;
   shape : Shape.t;
   ty : ty;
@@ -185,7 +186,8 @@ val pp : t Fmt.t
 val pp_debug : t Fmt.t
 
 val create : node -> t
-(** Create a network from its output node *)
+(** Create a network from its output node,
+    it must have only one input *)
 
 val output : t -> node
 (** Output node of the network *)
-- 
GitLab