parse_args.py

#!/usr/bin/env python3
###############################################################################
#
# MIT License
#
# Copyright (c) 2022 Advanced Micro Devices, Inc.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
#
###############################################################################
""" Module to centralize command line argument parsing """
import sys
import argparse
from enum import Enum
from typing import List, Optional
import jsonargparse
from tuna.miopen.utils.config_type import ConfigType
from tuna.libraries import Library


class TunaArgs(Enum):
  """ Enumeration of all the common argument supported by setup_arg_parser """
  ARCH: str = 'arch'
  NUM_CU: str = 'num_cu'
  DIRECTION: str = 'direction'
  VERSION: str = 'version'
  CONFIG_TYPE: str = 'config_type'
  SESSION_ID: str = 'session_id'
  MACHINES: str = 'machines'
  REMOTE_MACHINE: str = 'remote_machine'
  LABEL: str = 'label'
  RESTART_MACHINE: str = 'restart_machine'
  DOCKER_NAME: str = 'docker_name'
  SHUTDOWN_WORKERS: str = 'shutdown_workers'
  ENQUEUE_ONLY: str = 'enqueue_only'


# pylint: disable=too-many-branches
def setup_arg_parser(desc: str,
                     arg_list: List[TunaArgs],
                     parser: argparse.Namespace = None,
                     with_yaml: bool = True) -> Optional[argparse.Namespace]:
  """ function to aggregate common command line args """
  parser = jsonargparse.ArgumentParser(description=desc)

  if parser is not None:
    if with_yaml:
      parser.add_argument('--yaml', action=jsonargparse.ActionConfigFile)

    if TunaArgs.ARCH in arg_list:
      parser.add_argument('-a',
                          '--arch',
                          type=str,
                          dest='arch',
                          default=None,
                          required=False,
                          help='Architecture of machines',
                          choices=[
                              'gfx900', 'gfx906', 'gfx908', 'gfx1030', 'gfx90a',
                              'gfx940', 'gfx942', 'gfx950'
                          ])
    if TunaArgs.NUM_CU in arg_list:
      parser.add_argument('-n',
                          '--num_cu',
                          dest='num_cu',
                          type=int,
                          default=None,
                          required=False,
                          help='Number of CUs on GPU',
                          choices=[
                              '36', '56', '60', '64', '104', '110', '120',
                              '228', '256', '304'
                          ])
    if TunaArgs.DIRECTION in arg_list:
      parser.add_argument(
          '-d',
          '--direction',
          type=str,
          dest='direction',
          default=None,
          help='Direction of tunning, None means all (fwd, bwd, wrw), \
                          fwd = 1, bwd = 2, wrw = 4.',
          choices=[None, '1', '2', '4'])
    if TunaArgs.CONFIG_TYPE in arg_list:
      parser.add_argument('-C',
                          '--config_type',
                          dest='config_type',
                          help='Specify configuration type',
                          default=ConfigType.convolution,
                          choices=[cft.value for cft in ConfigType],
                          type=ConfigType)
    # pylint: disable=duplicate-code
    if TunaArgs.SESSION_ID in arg_list:
      parser.add_argument('--session_id',
                          dest='session_id',
                          type=int,
                          help='Session ID to be used as tuning tracker.\
        Allows to correlate DB results to tuning sessions')
    # pylint: enable=duplicate-code
    if TunaArgs.MACHINES in arg_list:
      parser.add_argument('-m',
                          '--machines',
                          dest='machines',
                          type=str,
                          default=None,
                          required=False,
                          help='Specify machine ids to use, comma separated')
    if TunaArgs.REMOTE_MACHINE in arg_list:
      parser.add_argument('--remote_machine',
                          dest='remote_machine',
                          action='store_true',
                          default=False,
                          help='Run the process on a network machine')
    if TunaArgs.LABEL in arg_list:
      parser.add_argument('-l',
                          '--label',
                          dest='label',
                          type=str,
                          default=None,
                          help='Specify label for jobs')
    if TunaArgs.RESTART_MACHINE in arg_list:
      parser.add_argument('-r',
                          '--restart',
                          dest='restart_machine',
                          action='store_true',
                          default=False,
                          help='Restart machines')
    if TunaArgs.DOCKER_NAME in arg_list:
      parser.add_argument(
          '--docker_name',
          dest='docker_name',
          type=str,
          default='',
          help='Select a docker to run on. (default miopentuna)')
    if TunaArgs.SHUTDOWN_WORKERS in arg_list:
      parser.add_argument('--shutdown_workers',
                          dest='shutdown_workers',
                          action='store_true',
                          help='Shutdown all active celery workers')

    if TunaArgs.ENQUEUE_ONLY in arg_list:
      parser.add_argument('--enqueue_only',
                          action='store_true',
                          dest='enqueue_only',
                          help='Enqueue jobs to celery queue')

  return parser


def clean_args() -> None:
  """clean arguments"""
  libs: List[Library] = [elem.value for elem in Library]
  for lib in libs:
    if lib in sys.argv:
      sys.argv.remove(lib)


def args_check(args: argparse.Namespace, parser: argparse.Namespace) -> None:
  """Common scripts args check function"""
  if args.machines is not None:
    args.machines = [int(x) for x in args.machines.split(',')
                    ] if ',' in args.machines else [int(args.machines)]

  args.local_machine = not args.remote_machine

  if args.init_session and not args.label:
    parser.error(
        "When setting up a new tunning session the following must be specified: "\
        "label.")