Package ai.sklearn4j.core.packaging

Interface IScikitLearnPackage

  • All Known Implementing Classes:
    ScikitLearnPackageV1
    public interface IScikitLearnPackage
    This interface provides an abstraction over the physical file format to decouple the deserialization logic from the file format. This will ease the modifications to the file format and versioning for backward compatibility.

    • Method Detail

      • getPackageHeader

        IScikitLearnPackageHeader getPackageHeader()
        Gets the object that stores the information provided in the binary package file header. The header include at the minimum the version of the file and the version of scikit-learn used to train the content of the file.
        Returns:
        An instance of IScikitLearnPackageHeader containing the parsed information of the file header.

      • getExtraValues

        Map<String,​Object> getExtraValues()
        Gets a Map[String: Object] of the extra values stored by the developer when saving the binary package.
        Returns:
        A dictionary that contains the extra values stored along with the binary package file.

      • getModel

        Object getModel​(String name)
        Get the primary content stored in binary package file.
        Parameters:
        name - Name of the content to retrieve.
        Returns:
        A scikit-learn object that can now be used in Java.

      • loadFromFile

        void loadFromFile​(String path)
        Loads the binary package from a file.
        Parameters:
        path - Path of file to be loaded.