One name for Namespaces, Projects, Assemblies, Folders and NuGets
- Whenever possible, related items in REEF.NET shall share the same name.
- The same name is also used for the folder that contains the project
- Sub-Namespaces are created as folders in the Project.
- For example, Tang is in the Project
Org.Apache.REEF.Tang, which produces the DLLOrg.Apache.REEF.Tang.dll, all classes within are in the NamespaceOrg.Apache.REEF.Tang.
Project List
| Project / Namespace / Artifact Name | Type | Contents | Notes |
|---|---|---|---|
| Org.Apache.REEF.Tang | DLL | Tang | |
| Org.Apache.REEF.Tang.Tools | EXE | Tang tools (e.g. the class hierarchy builder) | |
| Org.Apache.REEF.Wake | DLL | Wake | |
| Org.Apache.REEF.Driver | DLL | Driver | |
| Org.Apache.REEF.Evaluator | EXE | Evaluator | |
| Org.Apache.REEF.Common | DLL | Common code shared between Driver and Evaluator | |
| Org.Apache.REEF.Examples | DLL | REEF Examples | We might create additional projects in sub-namespaces for large examples |
| Org.Apache.REEF.Tests | ? | Integration tests | This is the equivalent to the integration test suite found in the Java module Not sure whether this is an EXE or Test project. |
| Org.Apache.REEF.Utilities | DLL | Helper classes. This project may not have dependencies. | |
| Org.Apache.REEF.Network | DLL | Networking Services for REEF | |
| Org.Apache.REEF.ClientLib | DLL | Client library for REEF: Job submission and management | This essentially calls the Java code to do the work, probably via a basic command line interface implemented in Java. |
| Org.Apache.REEF.Client | EXE | Command line client for REEF | We don't have this yet. |
Unit Tests
Every of the above projects has a test-project associated with it. Test projects have the same name as the project they test, with the added suffix Tests. The Tang tests can e.g. be found in Org.Apache.REEF.Tang.Tests.
The project Org.Apache.REEF.Tests contains integration tests.