Merge pull request #182 from mlcommons/dev

Merge dev

Author: anandhu-eng

.github/workflows/publish.yml

@@ -9,7 +9,7 @@ on:
       - main
       - dev
 permissions:
-  contents: read
+  contents: write
 jobs:
   publish:
     name: Publish the site

.github/workflows/test-mlc-core-actions.yaml

@@ -206,7 +206,7 @@ jobs:
     - name: Test 22 - Test recursive mlc pull repo
       run: |
         export MLC_REPOS=$HOME/test
-        mlc pull repo https://github.com/GATEOverflow/GO-PDFs
+        mlcp https://github.com/GATEOverflow/GO-PDFs
         mlcr detect,os -j
 
   test_mlc_access_core_actions:
@@ -271,9 +271,6 @@ jobs:
       matrix:
         python-version: ["3.12", "3.8"]
         os: ["ubuntu-latest", "windows-latest", "macos-latest"]
-        exclude:
-          - os: windows-latest
-          - os: macos-latest
 
     steps:
     - uses: actions/checkout@v4
@@ -294,38 +291,92 @@ jobs:
         python -m pip install .
     - name: MLC intro
       run: |
-        mlc help
+        mlc --help
+        mlc -h
     - name: MLC scripts - full
       run: |
-        mlc help script
+        mlc script --help
+        mlc script --h
     - name: MLC scripts - individual actions
       run: |
-        mlc help add script
-        mlc help docker script
-        mlc help find script
-        mlc help search script
-        mlc help list script
-        mlc help rm script
-        mlc help run script
-        mlc help show script
-        mlc help test script
+        mlc add script --help
+        mlc docker script --help
+        mlc find script --help
+        mlc search script --help
+        mlc list script --help
+        mlc rm script --help
+        mlc run script --help
+        mlc show script --help
+        mlc test script --help
+        mlc add script -h
+        mlc docker script -h
+        mlc find script -h
+        mlc search script -h
+        mlc list script -h
+        mlc rm script -h
+        mlc run script -h
+        mlc show script -h
+        mlc test script -h
     - name: MLC repos - full
       run: |
-        mlc help repo
+        mlc repo --help
+        mlc repo -h
     - name: MLC repos - individual actions
       run: |
-        mlc help add repo
-        mlc help find repo
-        mlc help pull repo
-        mlc help list repo
-        mlc help rm repo
+        mlc add repo --help
+        mlc find repo --help
+        mlc pull repo --help
+        mlc list repo --help
+        mlc rm repo --help
+        mlc add repo -h
+        mlc find repo -h
+        mlc pull repo -h
+        mlc list repo -h
+        mlc rm repo -h
     - name: MLC cache - full
       run: |
-        mlc help cache
+        mlc cache --help
+        mlc cache -h
     - name: MLC cache - individual actions
       run: |
-        mlc help find cache
-        mlc help list cache
-        mlc help rm cache
-        mlc help search cache
-        mlc help show cache
+        mlc find cache --help
+        mlc list cache --help
+        mlc rm cache --help
+        mlc search cache --help
+        mlc show cache --help
+        mlc find cache -h
+        mlc list cache -h
+        mlc rm cache -h
+        mlc search cache -h
+        mlc show cache -h
+  
+  test_mlc_script_actions:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.13", "3.8"]
+        os: ["ubuntu-latest", "windows-latest", "macos-latest"]
+        action: ["mlcr", "mlce", "mlct"]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Configure git longpaths (Windows)
+      if: matrix.os == 'windows-latest'
+      run: |
+        git config --system core.longpaths true
+
+    - name: Install mlcflow from the pull request's source repository and branch
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install --ignore-installed --verbose pip setuptools
+        python -m pip install .
+    - name: MLC ${{matrix.action}} script
+      run: |
+        mlcp mlcommons@mlperf-automations
+        ${{matrix.action}} detect,cpu

.github/workflows/test-mlc-docker-core.yml

@@ -56,7 +56,7 @@ jobs:
 
     - name: Test --docker_cache 
       run: |
-        mlc docker run --tags=detect,os --docker_dt --docker_cache=no
+        mlcd detect,os --docker_dt --docker_cache=no
 
     - name: Test --docker_rebuild
       run: |

VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

mlc/cache_action.py

@@ -42,7 +42,32 @@ def search(self, i):
         """
         i['target_name'] = "cache"
         #logger.debug(f"Searching for cache with input: {i}")
-        return self.parent.search(i)
+        r = self.parent.search(i)
+        if r['return'] > 0:
+            return r
+        cleaned_list = []
+
+        for item in r['list']:
+            item_meta = item.meta
+            '''#handled in script automation now
+            dep = item_meta.get('dependent_cached_path')
+            if dep and not os.path.exists(dep):
+                continue  # skip item
+
+            deps = item_meta.get('dependent_cached_paths', '').split(',')
+            if any(d and not os.path.exists(d) for d in deps):
+                continue  # skip item
+            '''
+
+            expiration_time = item_meta.get('expiration_time')
+            if expiration_time is not None and expiration_time < time.time():
+                continue  # skip expired item
+
+            cleaned_list.append(item)
+
+        r['list'] = cleaned_list
+
+        return r
 
     find = search
 
@@ -98,6 +123,9 @@ def show(self, run_args):
         """
         self.action_type = "cache"
         res = self.search(run_args)
+        if res['return'] > 0:
+            return res
+
         logger.info(f"Showing cache with tags: {run_args.get('tags')}")
         cached_meta_keys_to_show = ["uid", "tags", "dependent_cached_path", "associated_script_item"]
         cached_state_keys_to_show = ["new_env", "new_state", "version"]

mlc/main.py

@@ -75,17 +75,26 @@ def search(self, i):
         #indices
 
 
-def mlcr():
-    first_arg_value = "run"
-    second_arg_value = "script"
+def mlc_expand_short(action, target = "script"):
 
     # Insert the positional argument into sys.argv for the main function
-    sys.argv.insert(1, first_arg_value)
-    sys.argv.insert(2, second_arg_value)
+    sys.argv.insert(1, action)
+    sys.argv.insert(2, target)
 
     # Call the main function
     main()
 
+def mlcr():
+    mlc_expand_short("run")
+def mlcd():
+    mlc_expand_short("docker")
+def mlce():
+    mlc_expand_short("experiment")
+def mlct():
+    mlc_expand_short("test")
+
+def mlcp():
+    mlc_expand_short("pull", "repo")
 
 
 def process_console_output(res, target, action, run_args):
@@ -132,12 +141,63 @@ def main():
       
     For help related to a particular target, run: 
     
-    mlc help <target>
+    mlc <target> --help/-h
+
+    Examples:
+      mlc script --help
+      mlc repo -h
     
     For help related to a specific action for a target, run: 
     
-    mlc help <action> <target>
+    mlc <action> <target> --help/-h
+    Examples:
+      mlc run script --help
+      mlc pull repo -h
     """
+
+    # First level parser for showing help
+    pre_parser = argparse.ArgumentParser(add_help=False)
+    pre_parser.add_argument("action", nargs="?", help="Top-level action (run, build, help, etc.)")
+    pre_parser.add_argument("target", choices=['run', 'script', 'cache', 'repo'], nargs="?", help="Potential target (repo, script, cache, ...)")
+    pre_parser.add_argument("-h", "--help", action="store_true")
+    pre_args, remaining_args = pre_parser.parse_known_args()
+
+    if pre_args.help and not any("--tags" in arg for arg in remaining_args):
+        help_text = ""
+        if pre_args.target == "run":
+            if pre_args.action == "docker":
+                pre_args.target = "script"
+            else:
+                logger.error(f"Invalid action-target {pre_args.action} - {pre_args.target} combination")
+                raise Exception(f"Invalid action-target {pre_args.action} - {pre_args.target} combination")
+        if not pre_args.action and not pre_args.target:
+            help_text += main.__doc__
+        elif pre_args.action and not pre_args.target:
+            if pre_args.action not in ['script', 'cache', 'repo']:
+                logger.error(f"Invalid target {pre_args.action}")
+                raise Exception(f"""Invalid target {pre_args.action}""")
+            else:
+                pre_args.target, pre_args.action = pre_args.action, None
+            actions = get_action(pre_args.target, default_parent)
+            help_text += actions.__doc__
+            # iterate through every method
+            for method_name, method in inspect.getmembers(actions.__class__, inspect.isfunction):
+                method = getattr(actions, method_name)
+                if method.__doc__ and not method.__doc__.startswith("_"):
+                    help_text += method.__doc__
+        elif pre_args.action and pre_args.target:
+            actions = get_action(pre_args.target, default_parent)
+            try:
+                method = getattr(actions, pre_args.action)
+                help_text += actions.__doc__
+                help_text += method.__doc__
+            except:
+                logger.error(f"Error: '{pre_args.action}' is not supported for {pre_args.target}.")
+        if help_text != "":
+            print(help_text)
+        sys.exit(0)
+    
+    # parser for execution of the automation scripts
     parser = argparse.ArgumentParser(prog='mlc', description='A CLI tool for managing repos, scripts, and caches.', add_help=False)
 
     # Subparsers are added to main parser, allowing for different commands (subcommands) to be defined. 
@@ -146,30 +206,24 @@ def main():
 
     # Script and Cache-specific subcommands
     for action in ['run', 'pull', 'test', 'add', 'show', 'list', 'find', 'search', 'rm', 'cp', 'mv']:
-        action_parser = subparsers.add_parser(action, help=f'{action} a target.')
+        action_parser = subparsers.add_parser(action, add_help=False)
         action_parser.add_argument('target', choices=['repo', 'script', 'cache'], help='Target type (repo, script, cache).')
         # the argument given after target and before any extra options like --tags will be stored in "details"
         action_parser.add_argument('details', nargs='?', help='Details or identifier (optional for list).')
         action_parser.add_argument('extra', nargs=argparse.REMAINDER, help='Extra options (e.g.,  -v)')
 
     # Script specific subcommands
     for action in ['docker', 'experiment', 'doc', 'lint']:
-        action_parser = subparsers.add_parser(action, help=f'{action.capitalize()} a target.')
+        action_parser = subparsers.add_parser(action, add_help=False)
         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"
         action_parser.add_argument('details', nargs='?', help='Details or identifier (optional for list).')
         action_parser.add_argument('extra', nargs=argparse.REMAINDER, help='Extra options (e.g.,  -v)')
 
     for action in ['load']:
-        load_parser = subparsers.add_parser(action, help=f'{action.capitalize()} a target.')
+        load_parser = subparsers.add_parser(action, add_help=False)
         load_parser.add_argument('target', choices=['cfg'], help='Target type (cfg).')
 
-    for action in ['help']:
-        action_parser = subparsers.add_parser(action, help=f'{action.capitalize()} a target.')
-        action_parser.add_argument('action', help='action type (run).', nargs='?', default=None)
-        action_parser.add_argument('target', choices=['script', 'cache', 'repo'], help='Target type (script).', nargs='?', default=None)
-        action_parser.add_argument('extra', nargs=argparse.REMAINDER, help='Extra options (e.g.,  -v)')
-    
     # Parse arguments
     args = parser.parse_args()
 
@@ -201,45 +255,7 @@ def main():
 
     run_args = res['args_dict']
 
-    # handle help in mlcflow
-    if args.command in ['help']:
-        help_text = ""
-        if not args.action and not args.target:
-            help_text += main.__doc__
-        elif args.action and not args.target:
-            if args.action not in ['script', 'cache', 'repo']:
-                logger.error(f"Invalid target {args.action}")
-                raise Exception(f"""Invalid target {args.action}""")
-            else:
-                args.target, args.action = args.action, None
-            actions = get_action(args.target, default_parent)
-            help_text += actions.__doc__
-            # iterate through every method
-            for method_name, method in inspect.getmembers(actions.__class__, inspect.isfunction):
-                method = getattr(actions, method_name)
-                if method.__doc__ and not method.__doc__.startswith("_"):
-                    help_text += method.__doc__
-        elif args.action and args.target and run_args.get('tags'):
-            actions = get_action(args.target, default_parent)
-            if actions and hasattr(actions, args.command):
-                method = getattr(actions, args.command)
-                res = method(run_args)
-                if res['return'] > 0:
-                    logger.error(res.get('error', f"Error in {action}"))
-                    raise Exception(f"""An error occurred {res}""")
-            else:
-                logger.error(f"Error: '{args.command}' is not supported for {args.target}.")
-        elif args.action and args.target:
-            actions = get_action(args.target, default_parent)
-            try:
-                method = getattr(actions, args.action)
-                help_text += actions.__doc__
-                help_text += method.__doc__
-            except:
-                logger.error(f"Error: '{args.action}' is not supported for {args.target}.")
-        if help_text != "":
-            print(help_text)
-        sys.exit(0)
+    run_args['mlc_run_cmd'] = " ".join(sys.argv)
 
     if hasattr(args, 'repo') and args.repo:
         run_args['repo'] = args.repo

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "mlcflow"
-version = "1.0.20"
+version = "1.0.23"
 
 
 
@@ -47,3 +47,7 @@ py-modules = []
 [project.scripts]
 mlc = "mlc.main:main"
 mlcr = "mlc.main:mlcr"
+mlcd = "mlc.main:mlcd"
+mlce = "mlc.main:mlce"
+mlct = "mlc.main:mlct"
+mlcp = "mlc.main:mlcp"