create common description

bioimage-io · Oct 19, 2024 · 2a55abc · 2a55abc
1 parent 45ccf89
commit 2a55abc
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 41 deletions.
diff --git a/src/main/java/io/bioimage/modelrunner/bioimageio/description/ModelDescriptor.java b/src/main/java/io/bioimage/modelrunner/bioimageio/description/ModelDescriptor.java
@@ -34,25 +34,19 @@
  * @author Carlos Garcia Lopez de Haro and Daniel Felipe Gonzalez Obando
  */
 public interface ModelDescriptor {
+
+	static final String TEXT_DESCRIPTION = ""
+			+ "Model name: %s" + System.lineSeparator()
+			+ "Model nickname: %s" + System.lineSeparator()
+			+ "Model description: %s" + System.lineSeparator()
+			+ "Model author(s): %s" + System.lineSeparator()
+			+ "Model citation: %s" + System.lineSeparator();
 
     /**
      * Create a set of specifications about the basic info of the model: name od the model, authors,
      * references and Deep Learning framework
      * @return a set of specs for the model
      */
-    public String buildBasicInfo();
-
-    /**
-     * Write the tiling specs for the model
-     * @return the tiling specs for the model
-     */
-    public String buildTilingInfo();
-
-    /**
-     * Create specifications of the model containing the most important
-     * info that is going to be displayed on the DeepIcy plugin
-     * @return a String with the most important info
-     */
     public String buildInfo();
 
     /**

diff --git a/src/main/java/io/bioimage/modelrunner/bioimageio/description/ModelDescriptorV04.java b/src/main/java/io/bioimage/modelrunner/bioimageio/description/ModelDescriptorV04.java
@@ -788,22 +788,10 @@ public boolean canRunOnBioengine() {
 		return this.supportBioengine;
 	}
 
-	@Override
-	public String buildBasicInfo() {
-		// TODO Auto-generated method stub
-		return null;
-	}
-
-	@Override
-	public String buildTilingInfo() {
-		// TODO Auto-generated method stub
-		return null;
-	}
-
 	@Override
 	public String buildInfo() {
-		// TODO Auto-generated method stub
-		return null;
+		return String.format(TEXT_DESCRIPTION, this.name, this.getNickname(), this.description, this.authors.toString(),
+				this.cite.toString());
 	}
 
 	@Override

diff --git a/src/main/java/io/bioimage/modelrunner/bioimageio/description/ModelDescriptorV05.java b/src/main/java/io/bioimage/modelrunner/bioimageio/description/ModelDescriptorV05.java
@@ -643,22 +643,10 @@ public boolean canRunOnBioengine() {
 		return this.supportBioengine;
 	}
 
-	@Override
-	public String buildBasicInfo() {
-		// TODO Auto-generated method stub
-		return null;
-	}
-
-	@Override
-	public String buildTilingInfo() {
-		// TODO Auto-generated method stub
-		return null;
-	}
-
 	@Override
 	public String buildInfo() {
-		// TODO Auto-generated method stub
-		return null;
+		return String.format(TEXT_DESCRIPTION, this.name, this.getNickname(), this.description, this.authors.toString(),
+				this.cite.toString());
 	}
 
 	@Override