org.apache.sysml.api.mlcontext

Class ScriptFactory



  • public class ScriptFactory
    extends Object
    Factory for creating DML and PYDML Script objects from strings, files, URLs, and input streams.
    • Constructor Detail

      • ScriptFactory

        public ScriptFactory()
    • Method Detail

      • dmlFromFile

        public static Script dmlFromFile(String scriptFilePath)
        Create a DML Script object based on a string path to a file.
        Parameters:
        scriptFilePath - path to DML script file (local or HDFS)
        Returns:
        DML Script object
      • dmlFromInputStream

        public static Script dmlFromInputStream(InputStream inputStream)
        Create a DML Script object based on an input stream.
        Parameters:
        inputStream - input stream to DML
        Returns:
        DML Script object
      • dmlFromLocalFile

        public static Script dmlFromLocalFile(File localScriptFile)
        Creates a DML Script object based on a file in the local file system. To create a DML Script object from a local file or HDFS, please use dmlFromFile(String).
        Parameters:
        localScriptFile - the local DML file
        Returns:
        DML Script object
      • dmlFromString

        public static Script dmlFromString(String scriptString)
        Create a DML Script object based on a string.
        Parameters:
        scriptString - string of DML
        Returns:
        DML Script object
      • dmlFromUrl

        public static Script dmlFromUrl(String scriptUrlPath)
        Create a DML Script object based on a URL path.
        Parameters:
        scriptUrlPath - URL path to DML script
        Returns:
        DML Script object
      • dmlFromUrl

        public static Script dmlFromUrl(URL scriptUrl)
        Create a DML Script object based on a URL.
        Parameters:
        scriptUrl - URL to DML script
        Returns:
        DML Script object
      • dmlFromResource

        public static Script dmlFromResource(String resourcePath)
        Create a DML Script object based on a resource path.
        Parameters:
        resourcePath - path to a resource on the classpath
        Returns:
        DML Script object
      • pydmlFromFile

        public static Script pydmlFromFile(String scriptFilePath)
        Create a PYDML Script object based on a string path to a file.
        Parameters:
        scriptFilePath - path to PYDML script file (local or HDFS)
        Returns:
        PYDML Script object
      • pydmlFromInputStream

        public static Script pydmlFromInputStream(InputStream inputStream)
        Create a PYDML Script object based on an input stream.
        Parameters:
        inputStream - input stream to PYDML
        Returns:
        PYDML Script object
      • pydmlFromLocalFile

        public static Script pydmlFromLocalFile(File localScriptFile)
        Creates a PYDML Script object based on a file in the local file system. To create a PYDML Script object from a local file or HDFS, please use pydmlFromFile(String).
        Parameters:
        localScriptFile - the local PYDML file
        Returns:
        PYDML Script object
      • pydmlFromString

        public static Script pydmlFromString(String scriptString)
        Create a PYDML Script object based on a string.
        Parameters:
        scriptString - string of PYDML
        Returns:
        PYDML Script object
      • pydmlFromUrl

        public static Script pydmlFromUrl(String scriptUrlPath)
        Creat a PYDML Script object based on a URL path.
        Parameters:
        scriptUrlPath - URL path to PYDML script
        Returns:
        PYDML Script object
      • pydmlFromUrl

        public static Script pydmlFromUrl(URL scriptUrl)
        Create a PYDML Script object based on a URL.
        Parameters:
        scriptUrl - URL to PYDML script
        Returns:
        PYDML Script object
      • pydmlFromResource

        public static Script pydmlFromResource(String resourcePath)
        Create a PYDML Script object based on a resource path.
        Parameters:
        resourcePath - path to a resource on the classpath
        Returns:
        PYDML Script object
      • dml

        public static Script dml(String scriptString)
        Create a DML Script object based on a string.
        Parameters:
        scriptString - string of DML
        Returns:
        DML Script object
      • pydml

        public static Script pydml(String scriptString)
        Create a PYDML script object based on a string.
        Parameters:
        scriptString - string of PYDML
        Returns:
        PYDML Script object

Copyright © 2017 The Apache Software Foundation. All rights reserved.