Packages

c

ml.dmlc.xgboost4j.java

ExternalCheckpointManager

class ExternalCheckpointManager extends AnyRef

This class contains the methods that are required for managing the state of the training process. The training state is stored in a distributed file system, that consists of UBJ (Universal Binary JSON) model files. The class provides methods for saving, loading and cleaning up checkpoints.

Linear Supertypes
AnyRef, Any
Known Subclasses
ExternalCheckpointManager
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ExternalCheckpointManager
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ExternalCheckpointManager(checkpointPath: String, fs: FileSystem)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def cleanPath(): Unit

    This method cleans all the directories and files that are present in the checkpoint path.

    This method cleans all the directories and files that are present in the checkpoint path.

    Exceptions thrown

    IOException exception that is thrown when there is an error deleting the checkpoint path.

  6. def cleanUpHigherVersions(currentRound: Int): Unit

    This method cleans up all the checkpoint versions that are higher than the current round.

    This method cleans up all the checkpoint versions that are higher than the current round. This is useful when multiple training instances are running and we want to make sure that only the checkpoints from the current training instance are retained.

    currentRound

    The current round of training.

    Exceptions thrown

    IOException Any exception that occurs when deleting the checkpoint files.

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def getCheckpointRounds(firstRound: Int, checkpointInterval: Int, numOfRounds: Int): List[Integer]

    Get a list of iterations that need checkpointing.

    Get a list of iterations that need checkpointing.

    firstRound

    The first round of training.

    checkpointInterval

    The interval at which checkpoints are to be saved.

    numOfRounds

    The number of rounds to be trained.

    returns

    A list of integer rounds that need checkpointing.

    Exceptions thrown

    IOException Any exception that occurs when getting the list of rounds.

  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def loadCheckpointAsBooster(): Booster

    Read the checkpoint from the checkpoint path.

    Read the checkpoint from the checkpoint path. Once the checkpoint path is read, we get the latest version of the checkpoint from all the checkpoint versions and lead it into the booster for the purpose of making predictions.

    returns

    The booster object that is used for making predictions.

    Exceptions thrown

    IOException Any expection that occurs when reading the checkpoint path.

    XGBoostError Any exception that occurs when loading the model into the booster.

  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. def updateCheckpoint(boosterToCheckpoint: Booster): Unit

    This method updates the booster checkpoint to the the latest or current version and deleted all the previous versions of the checkpoint.

    This method updates the booster checkpoint to the the latest or current version and deleted all the previous versions of the checkpoint.

    boosterToCheckpoint

    The booster object that is to be checkpointed and saved as a model file.

    Exceptions thrown

    IOException Any exception that occurs when writing the model file to the checkpoint path.

    XGBoostError Any exception that occurs when saving the model from the booster.

  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped