REEF 0.16.0 API

Packages 
Package Description
org.apache.reef.annotations
Annotations used to identify interface stability and audience.
org.apache.reef.annotations.audience
Annotations for interface audience.
org.apache.reef.annotations.semantics
Contains annotations capturing the semantics of APIs, e.g.
org.apache.reef.bridge.client
Contains the client of the bridge.
org.apache.reef.bridge.message  
org.apache.reef.client
Client APIs for REEF.
org.apache.reef.client.parameters
Named parameters for the REEF client API.
org.apache.reef.common
REEF Common.
org.apache.reef.driver
Driver APIs for REEF in terms of Rx.
org.apache.reef.driver.catalog
Interfaces describing resources available to a REEF instance (physical nodes, racks etc).
org.apache.reef.driver.client
Representations of the Client (i.e.
org.apache.reef.driver.context
Driver Contexts and their configurations.
org.apache.reef.driver.evaluator
Evaluator-related utilities.
org.apache.reef.driver.parameters
Named parameters used by the Driver.
org.apache.reef.driver.restart
This package provides restart event service handlers.
org.apache.reef.driver.task
Tasks and their configurations.
org.apache.reef.evaluator.context
Evaluator Contexts.
org.apache.reef.evaluator.context.events
Events signaling change of Evaluator state.
org.apache.reef.evaluator.context.parameters
Named parameters used by the Evaluator.
org.apache.reef.examples.data.loading
A line counter example using data loading service.
org.apache.reef.examples.data.output
Example application using the output service.
org.apache.reef.examples.distributedshell
Simple Distributed Shell example.
org.apache.reef.examples.group.bgd
Runs BGD on the given runtime.
org.apache.reef.examples.group.bgd.data
Interface for example data instance for linear models.
org.apache.reef.examples.group.bgd.data.parser
A parser interface and implementation for SVMLight records.
org.apache.reef.examples.group.bgd.loss
Loss Functions for BGD.
org.apache.reef.examples.group.bgd.operatornames
Parameter names used to identify the various operators used in BGD.
org.apache.reef.examples.group.bgd.parameters
Parameters for BGD.
org.apache.reef.examples.group.bgd.utils
Utility functions for BGD.
org.apache.reef.examples.group.broadcast
Broadcast Group Communication example.
org.apache.reef.examples.group.broadcast.parameters
Parameters for Broadcast group communication.
org.apache.reef.examples.group.utils.math
Math utilities for Group Communication.
org.apache.reef.examples.group.utils.timer
Timer for Group Communication.
org.apache.reef.examples.hello
The Hello REEF example for the HDInsight.
org.apache.reef.examples.helloCLR
The Hello REEF example for the CLR.
org.apache.reef.examples.hellohttp
Distributed shell example based on REEF HTTP Server component.
org.apache.reef.examples.hellomultiruntime
The Hello REEF Multi Runtime example.
org.apache.reef.examples.library
A library for distributed shell example.
org.apache.reef.examples.pool
Allocate N evaluators, submit M tasks to them, and measure the time.
org.apache.reef.examples.reefonreef
REEF-on-REEF example.
org.apache.reef.examples.scheduler
Task scheduler example based on reef-webserver.
org.apache.reef.examples.scheduler.client
Task scheduler example client classes.
org.apache.reef.examples.scheduler.driver
Task scheduler example driver classes.
org.apache.reef.examples.scheduler.driver.exceptions
Task scheduler example exceptions.
org.apache.reef.examples.scheduler.driver.http
Task scheduler example HTTP API.
org.apache.reef.examples.suspend
Suspend/resume demo.
org.apache.reef.examples.utils.wake
Logging and Blocking event handlers.
org.apache.reef.exception
Exceptions thrown to Job Drivers.
org.apache.reef.exception.evaluator
Exceptions thrown in the Evaluators.
org.apache.reef.experimental
Experimental projects for REEF.
org.apache.reef.experimental.parquet
Experimental projects for REEF.
org.apache.reef.io
APIs for I/O in REEF: Codecs and Serializers.
org.apache.reef.io.checkpoint
Checkpoints that provide APIs and implementations to store and retrieve the state of a task.
org.apache.reef.io.checkpoint.fs
Provides an example implementation of a CheckpointService based on a file system.
org.apache.reef.io.data.loading.api
Data Loading Service API.
org.apache.reef.io.data.loading.avro  
org.apache.reef.io.data.loading.impl
Implementations of Data Loading Service.
org.apache.reef.io.data.output
Data Output Service.
org.apache.reef.io.naming
Utilities for assigning Identifiers to objects and associating socket addresses with them.
org.apache.reef.io.network
TODO: Document.
org.apache.reef.io.network.exception
Network service exceptions.
org.apache.reef.io.network.group
Elastic Group Communications for REEF.
org.apache.reef.io.network.group.api
Elastic Group Communications API.
org.apache.reef.io.network.group.api.config
The operator configurations used by users.
org.apache.reef.io.network.group.api.driver
Elastic Group Communications Driver-side API Interfaces.
org.apache.reef.io.network.group.api.operators
Provides the interfaces for MPI style group communication operations.
org.apache.reef.io.network.group.api.task
Elastic Group Communications Task-side API Interfaces.
org.apache.reef.io.network.group.impl
Implementations for Elastic Group Communications.
org.apache.reef.io.network.group.impl.config
Group Communication Operator Specifications.
org.apache.reef.io.network.group.impl.config.parameters
Parameters for Elastic Group Communications.
org.apache.reef.io.network.group.impl.driver
This package contains the implementation of the driver side of the Group Communication Service using the tree/flat topology.
org.apache.reef.io.network.group.impl.operators
Implementations for Group Communication Operators.
org.apache.reef.io.network.group.impl.task
Implementations for Elastic Group Communications Task-side API.
org.apache.reef.io.network.group.impl.utils
Utilities for group communication.
org.apache.reef.io.network.impl
TODO: Document.
org.apache.reef.io.network.impl.config
TODO: Document.
org.apache.reef.io.network.naming
TODO: Document.
org.apache.reef.io.network.naming.avro  
org.apache.reef.io.network.naming.exception
TODO: Document.
org.apache.reef.io.network.naming.parameters
TODO: Document.
org.apache.reef.io.network.naming.serialization
Contains naming serialization codecs.
org.apache.reef.io.network.proto  
org.apache.reef.io.network.util
Utility for REEF IO network module.
org.apache.reef.io.parameters
Parameters for reef-common.src.main.java.org.apache.reef.io.
org.apache.reef.io.serialization
Serialization utilities.
org.apache.reef.io.storage
APIs for Storage Service.
org.apache.reef.io.storage.local
Implementations for local filesystem-based storage service.
org.apache.reef.io.storage.ram
Implementations for RAM-based storage service.
org.apache.reef.io.storage.util
Utilities for storage services.
org.apache.reef.io.watcher
Watcher subscribes events and writes them to the destination using a certain EventStream.
org.apache.reef.io.watcher.common  
org.apache.reef.io.watcher.driver.catalog  
org.apache.reef.io.watcher.driver.context  
org.apache.reef.io.watcher.driver.evaluator  
org.apache.reef.io.watcher.driver.task  
org.apache.reef.io.watcher.param
Parameters for Watcher.
org.apache.reef.io.watcher.util
Utility classes for Watcher.
org.apache.reef.io.watcher.wake.time.event  
org.apache.reef.io.watcher.wake.time.runtime.event  
org.apache.reef.javabridge
The Java-side of the CLR/Java bridge.
org.apache.reef.javabridge.avro  
org.apache.reef.javabridge.generic
Generic java bridge driver/client.
org.apache.reef.javabridge.utils
utils for clr bridge.
org.apache.reef.poison
Fault injection for REEF.
org.apache.reef.poison.context
Fault Injection into REEF contexts.
org.apache.reef.poison.params
Parameters of fault injections.
org.apache.reef.poison.task
Fault Injection into REEF tasks.
org.apache.reef.proto  
org.apache.reef.reef.bridge.client.avro  
org.apache.reef.runtime.common
REEF implementation.
org.apache.reef.runtime.common.client
Implementation of the client-side REEF API.
org.apache.reef.runtime.common.client.api
Client-Side Event Handlers to be implemented by a specific resourcemanager.
org.apache.reef.runtime.common.client.defaults
Default implementations for the optional client-side event handlers.
org.apache.reef.runtime.common.client.parameters
Parameters used by client.
org.apache.reef.runtime.common.driver
Implementation of the Driver-side REEF APIs.
org.apache.reef.runtime.common.driver.api
Driver-Side Event Handlers to be implemented by a specific resource manager.
org.apache.reef.runtime.common.driver.catalog
Implementations of descriptors for resources available to a REEF instance (physical nodes, racks etc).
org.apache.reef.runtime.common.driver.client
Objects representing the Client on the Driver.
org.apache.reef.runtime.common.driver.context
Implementations of Driver-Side representations of Contexts running on an Evaluator.
org.apache.reef.runtime.common.driver.defaults
Default implementations for the optional driver-side event handlers.
org.apache.reef.runtime.common.driver.evaluator
Driver-Side representations of Evaluators.
org.apache.reef.runtime.common.driver.evaluator.pojos
POJOs in this package encapsulate the content of an EvaluatorHeartbeatProto on the DriverSide.
org.apache.reef.runtime.common.driver.idle
Contains the Driver idle handling and extension APIs.
org.apache.reef.runtime.common.driver.parameters
Parameters for the driver.
org.apache.reef.runtime.common.driver.resourcemanager
Classes that interface with the resourcemanager (Local, YARN, ...) in the Driver.
org.apache.reef.runtime.common.driver.task
Driver-Side representations of tasks.
org.apache.reef.runtime.common.evaluator
Evaluator-side implementation of the REEF API.
org.apache.reef.runtime.common.evaluator.context
Context implementation of the Evaluator resourcemanager.
org.apache.reef.runtime.common.evaluator.context.defaults
Default implementations for the optional context interfaces.
org.apache.reef.runtime.common.evaluator.parameters
Parameters used by Evaluator.
org.apache.reef.runtime.common.evaluator.task
Task-related implementation of the Evaluator resourcemanager.
org.apache.reef.runtime.common.evaluator.task.defaults
Default implementations for the optional task interfaces.
org.apache.reef.runtime.common.evaluator.task.exceptions
Exceptions thrown by Tasks and Task Handlers.
org.apache.reef.runtime.common.files
This package will contain the implementation of the REEF file system standard.
org.apache.reef.runtime.common.launch
Common launch code between Driver and Evaluator.
org.apache.reef.runtime.common.launch.parameters
Parameters of the Launcher.
org.apache.reef.runtime.common.parameters
Parameters used by runtime.
org.apache.reef.runtime.common.utils
Runtime utilities used by various REEF modules.
org.apache.reef.runtime.hdinsight
HDInsight support for REEF.
org.apache.reef.runtime.hdinsight.cli
A command line interface for HDInsight.
org.apache.reef.runtime.hdinsight.client
The client to submit jobs to HDInsight.
org.apache.reef.runtime.hdinsight.client.sslhacks
Utils which do not check SSL.
org.apache.reef.runtime.hdinsight.client.yarnrest
Some minimal abstraction over the YARN REST API.
org.apache.reef.runtime.hdinsight.driver
HDInsight support for REEF.
org.apache.reef.runtime.hdinsight.parameters
Parameters for HDInsight connection.
org.apache.reef.runtime.local
A local implementation of REEF that uses local JVMs for execution.
org.apache.reef.runtime.local.client
Client-side event handlers for the local resourcemanager.
org.apache.reef.runtime.local.client.parameters
Parameters of the local runtime.
org.apache.reef.runtime.local.driver
The resource manager for the local resourcemanager.
org.apache.reef.runtime.local.process
Infrastructure for managing processes.
org.apache.reef.runtime.mesos
An YARN implementation of REEF that uses Mesos slaves for execution.
org.apache.reef.runtime.mesos.client
Client-side event handlers for Mesos resourcemanager.
org.apache.reef.runtime.mesos.client.parameters
Client-side parameters for Mesos job submission.
org.apache.reef.runtime.mesos.driver
Driver-side event handlers for Mesos resourcemanager.
org.apache.reef.runtime.mesos.driver.parameters
Driver-side parameters for Mesos job submission.
org.apache.reef.runtime.mesos.evaluator
Evaluator-side event handlers for Mesos resourcemanager.
org.apache.reef.runtime.mesos.evaluator.parameters
Evaluator-side parameters for Mesos job.
org.apache.reef.runtime.mesos.util
Utility for Mesos runtime.
org.apache.reef.runtime.multi.client
client side for the multi runtime implementation.
org.apache.reef.runtime.multi.client.parameters
Parameters for the multi runtime.
org.apache.reef.runtime.multi.driver
A multi runtime implementation of REEF that uses several runtime implementationsi for execution.
org.apache.reef.runtime.multi.driver.parameters
Parameters for multi runtime driver.
org.apache.reef.runtime.multi.utils
Utils for multi runtime.
org.apache.reef.runtime.multi.utils.avro  
org.apache.reef.runtime.standalone
A standalone implementation of REEF that uses remote JVMs for execution.
org.apache.reef.runtime.standalone.client
Client-side event handlers for the standalone resourcemanager.
org.apache.reef.runtime.standalone.client.parameters
Parameters of the standalone runtime.
org.apache.reef.runtime.standalone.driver
The resource manager for the standalone resourcemanager.
org.apache.reef.runtime.yarn
An YARN implementation of REEF that uses YARN container for execution.
org.apache.reef.runtime.yarn.client
Client-side event handlers for YARN resourcemanager.
org.apache.reef.runtime.yarn.client.parameters
Client-side parameters for YARN job submission.
org.apache.reef.runtime.yarn.client.unmanaged
Client-side event handlers for YARN resourcemanager and AM running in unmanaged mode.
org.apache.reef.runtime.yarn.client.uploader
Uploader to copy job resource files to YARN.
org.apache.reef.runtime.yarn.driver
The Driver-Side implementation of the YARN adapter for REEF.
org.apache.reef.runtime.yarn.driver.parameters
Driver-side parameters of YARN job submission.
org.apache.reef.runtime.yarn.driver.restart
The package contains classes that are used specifically on restart.
org.apache.reef.runtime.yarn.util
Utility for YARN runtime.
org.apache.reef.tang
Public interfaces and factories for Tang's core API.
org.apache.reef.tang.annotations
Annotations that application developers can use to register configuration metadata with Tang.
org.apache.reef.tang.examples
Example code from the tutorial on Tang's home page.
org.apache.reef.tang.examples.timer
A more complicated version of the Timer example, including delegating interfaces to default implementations.
org.apache.reef.tang.exceptions
Exceptions thrown by Tang, including runtime exceptions that reflect compile-time inconsistencies and other problems that can't be meaningfully handled by application code.
org.apache.reef.tang.formats
Tang format classes encode and decode information that Tang gathers at runtime.
org.apache.reef.tang.formats.avro  
org.apache.reef.tang.implementation
Tang's implementation.
org.apache.reef.tang.implementation.avro
Implementation classes that translate between Tang's core API and Avro.
org.apache.reef.tang.implementation.java
Private implementation classes that configure and inject code written in Java.
org.apache.reef.tang.implementation.protobuf
Implementation classes that translate between Tang's core API and protocol buffers.
org.apache.reef.tang.implementation.types
Implementations of the ClassHierarchy type system.
org.apache.reef.tang.proto  
org.apache.reef.tang.types
The interfaces that define Tang's ClassHierarchy objects.
org.apache.reef.tang.util
Utilities for Tang.
org.apache.reef.tang.util.walk
Utility classes for configuration graph and injection plan traversal.
org.apache.reef.tang.util.walk.graphviz
produce Graphviz representation of TANG configuration graph and injection plan.
org.apache.reef.task
Tasks.
org.apache.reef.task.events
Task-related events.
org.apache.reef.tests
Tests for REEF implementations.
org.apache.reef.tests.driver
Tests whether a Driver can successfully be launched and shut down.
org.apache.reef.tests.evaluator.failure
Tests for Evaluator failures.
org.apache.reef.tests.evaluator.failure.parameters
Parameters for FailureDriver.
org.apache.reef.tests.evaluatorreuse
This package contains a test of the Evaluator reuse.
org.apache.reef.tests.fail.driver
Tests for Driver-side failures.
org.apache.reef.tests.fail.task
Tests for Tasks fail in various cases.
org.apache.reef.tests.group
Tests for group communication.
org.apache.reef.tests.group.conf
Classes used in tang configuration related tests for group communication.
org.apache.reef.tests.library
Commonly used event handlers and task implementations in our tests.
org.apache.reef.tests.library.driver
Commonly used event handler implementations in our tests.
org.apache.reef.tests.library.exceptions
Exceptions used in our tests.
org.apache.reef.tests.library.tasks
Commonly used task implementations in our tests.
org.apache.reef.tests.messaging.driver
Tests the messaging channel between client and driver.
org.apache.reef.tests.messaging.task
Test message exchange between the Task and the Driver.
org.apache.reef.tests.rack.awareness
Tests for Rack-awareness.
org.apache.reef.tests.statepassing
Tests for State-passing.
org.apache.reef.tests.watcher
Test reef.io.watcher.
org.apache.reef.util
Utilities for using REEF on Hadoop.
org.apache.reef.util.cache
Cache utilities.
org.apache.reef.util.logging
Logging handler for clr bridge.
org.apache.reef.vortex
Vortex, a distributed runtime that makes efficient use of unreliable resources.
org.apache.reef.vortex.api
Vortex user api for running jobs on Vortex.
org.apache.reef.vortex.common
Code commonly used in VortexMaster and VortexWorker.
org.apache.reef.vortex.driver
Vortex Code that runs as part of REEF Driver.
org.apache.reef.vortex.evaluator
Vortex Code that runs as part of REEF Evaluator.
org.apache.reef.vortex.examples.addone
A Simple Vortex vector calculation example.
org.apache.reef.vortex.examples.hello
Vortex Hello World Example.
org.apache.reef.vortex.examples.matmul
A Simple Vortex matrix multiplication example.
org.apache.reef.vortex.examples.sumones
A Simple Vortex addition and aggregation example.
org.apache.reef.vortex.protocol.mastertoworker
Protocol from VortexMaster to VortexWorker.
org.apache.reef.vortex.protocol.workertomaster
Protocol from VortexWorker to VortexMaster.
org.apache.reef.wake
Public interfaces and factories for Wake's core API.
org.apache.reef.wake.examples
Wake examples.
org.apache.reef.wake.examples.accumulate
A key-value combiner example.
org.apache.reef.wake.examples.join
Blocking and non-blocking join example.
org.apache.reef.wake.examples.p2p
A simple pull to push adapter.
org.apache.reef.wake.exception
Wake exceptions.
org.apache.reef.wake.impl
Wake's implementation.
org.apache.reef.wake.metrics
Implementations of standard latency and throughput instrumentation.
org.apache.reef.wake.profiler
A graphical profiler that automatically instruments Tang-based Wake applications.
org.apache.reef.wake.remote
Wake's remote communication.
org.apache.reef.wake.remote.address
Local address resolution.
org.apache.reef.wake.remote.exception
Wake remote exceptions.
org.apache.reef.wake.remote.impl
Implementations for Wake's remote communication.
org.apache.reef.wake.remote.ports
TCP port providers.
org.apache.reef.wake.remote.ports.parameters
Parameters for TCP port selection.
org.apache.reef.wake.remote.proto  
org.apache.reef.wake.remote.transport
Wake's remote transportation.
org.apache.reef.wake.remote.transport.exception
Wake remote transport exceptions.
org.apache.reef.wake.remote.transport.netty
Netty-based remote transport implementation.
org.apache.reef.wake.rx
Wake's RX-style communication.
org.apache.reef.wake.rx.exception
RX-style communication exceptions.
org.apache.reef.wake.rx.impl
Wake's RX-style communication implementation.
org.apache.reef.wake.test.proto  
org.apache.reef.wake.time
Clock and time-based events(start/stop/alarm) implementation.
org.apache.reef.wake.time.event
Time-based events (start/stop/alarm).
org.apache.reef.wake.time.runtime  
org.apache.reef.wake.time.runtime.event
Runtime-related Wake events.
org.apache.reef.webserver
HTTP Server component to implement a REST API for the Driver or Evaluators.

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