Merge pull request #158 from GATEOverflow/dev

Merge from GO

Author: anandhu-eng

mlc/main.py

@@ -152,7 +152,7 @@ def main():
         action_parser.add_argument('extra', nargs=argparse.REMAINDER, help='Extra options (e.g.,  -v)')
 
     # Script specific subcommands
-    for action in ['docker', 'experiment']:
+    for action in ['docker', 'experiment', 'doc']:
         action_parser = subparsers.add_parser(action, help=f'{action.capitalize()} a target.')
         action_parser.add_argument('target', choices=['script', 'run'], help='Target type (script).')
         # the argument given after target and before any extra options like --tags will be stored in "details"
@@ -247,7 +247,7 @@ def main():
         if args.target == "repo":
             run_args['repo'] = args.details
 
-    if args.command in ['docker', 'experiment']:
+    if args.command in ['docker', 'experiment', 'doc']:
         if args.target == "run":
             run_args['target'] = 'script' #allowing run to be used for docker run instead of docker script
             args.target = "script"

mlc/script_action.py

@@ -53,7 +53,6 @@ def search(self, i):
         if not i.get('target_name'):
             i['target_name'] = "script"
         res = self.parent.search(i)
-        #print(res)
         return res
 
     find = search
@@ -235,6 +234,8 @@ def call_script_module_function(self, function_name, run_args):
                 result = automation_instance.test(run_args)  # Pass args to the run method
             elif function_name == "experiment":
                 result = automation_instance.experiment(run_args)  # Pass args to the experiment method
+            elif function_name == "doc":
+                result = automation_instance.doc(run_args)  # Pass args to the doc method
             else:
                 return {'return': 1, 'error': f'Function {function_name} is not supported'}
 
@@ -284,6 +285,7 @@ def docker(self, run_args):
         """
         return self.call_script_module_function("docker", run_args)
 
+
     def run(self, run_args):
         """
     ####################################################################################################################
@@ -306,11 +308,12 @@ def run(self, run_args):
         """
         return self.call_script_module_function("run", run_args)
 
+
     def test(self, run_args):
         """
     ####################################################################################################################
     Target: Script
-    Action: Run
+    Action: test
     ####################################################################################################################
 
     The `test` action validates scripts that are configured with a `tests` section in `meta.yaml`.  
@@ -322,10 +325,29 @@ def test(self, run_args):
         """
         return self.call_script_module_function("test", run_args)
 
+
+    def doc(self, run_args):
+        """
+    ####################################################################################################################
+    Target: Script
+    Action: doc
+    ####################################################################################################################
+
+    The `doc` action creates automatic README for scripts from the contents in `meta.yaml`.  
+
+    Example Command:
+
+    mlc doc script --tags=detect,os
+
+        """
+        return self.call_script_module_function("doc", run_args)
+
+
     def help(self, run_args):
         # Internal function to call the help function in script automation module.py
         return self.call_script_module_function("help", run_args)
 
+
     def list(self, args):
         """
     ####################################################################################################################

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "mlcflow"
-version = "1.0.16"
+version = "1.0.18"
 
 
 description = "An automation interface for ML applications"