-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #18 from boozallen/5-migrate-documentation-tranch-2
#5 📝 Tranche 2 of documentation migration
- Loading branch information
Showing
9 changed files
with
1,019 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
[#_adding_a_pipeline] | ||
= Adding a Pipeline | ||
Once you have generated your new project, it is time to add a pipeline. Pipelines are the core of most projects and are | ||
responsible for major data delivery and machine learning tasks. The following content walks through the process of | ||
standing up a pipeline at a very high level. | ||
=== Step 1: Creating the pipeline model file | ||
aiSSEMBLE(TM) uses Model Driven Architecture (MDA) to accelerate development. Pipeline models are JSON files used to | ||
drive the generation of multiple aspects in your project - including the pipeline code module and deployment modules. | ||
. Create a new JSON file in your project's `pipeline-model` directory. | ||
** Sample path: `test-project/test-project-pipeline-models/src/main/resources/pipelines` + | ||
. Create the model pipeline data within the newly added JSON file. For detailed options, see the pipeline | ||
xref:pipeline-metamodel.adoc[metamodel documentation]. | ||
.. *Note:* Ensure the name of the JSON file matches the `"name"` of the pipeline. | ||
*_Example:* Shown below is the SimpleDataDeliveryExample pipeline._ | ||
|
||
._View SimpleDataDeliveryExample.json_ | ||
[%collapsible] | ||
==== | ||
[source] | ||
---- | ||
{ | ||
"name":"SimpleDataDeliveryExample", | ||
"package":"com.boozallen.aissemble.documentation", | ||
"type":{ | ||
"name":"data-flow", | ||
"implementation":"data-delivery-spark" | ||
}, | ||
"steps":[ | ||
{ | ||
"name":"IngestData", | ||
"type":"synchronous", | ||
"dataProfiling":{ | ||
"enabled":false | ||
} | ||
} | ||
] | ||
} | ||
---- | ||
==== | ||
=== Step 2: Generating the pipeline code | ||
After creating your model pipeline, execute the build to trigger the creation of the Maven modules that accompany it. | ||
. Run the maven build to execute the MDA generation engine. | ||
.. `mvn clean install` | ||
. The MDA generator will take several build iterations to fully generate your project, and requires that you modify | ||
certain files to enable this generation. These *Manual Actions* are meant to guide you through that process, and will | ||
only need to be performed after changes to your pipeline model(s). | ||
[source] | ||
---- | ||
*********************************************************************** | ||
*** MANUAL ACTION NEEDED! *** | ||
*********************************************************************** | ||
---- | ||
[start=3] | ||
. Re-run the build and address all manual actions until they have been resolved. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
= aiSSEMBLE(TM) Approach | ||
|
||
aiSSEMBLE is a lean manufacturing approach for holistically designing, developing, and fielding AI. The aiSSEMBLE Baseline | ||
is a framework which builds on the software and machine learning engineering best practices and lessons learned, | ||
providing and maintaining reusable components, rather than a one-size-fits-all platform. In return, various members of | ||
your team, including solution architects, DevOps engineers, data/software engineers, and AI/ML practitioners can easily | ||
leverage these components to suit your business needs and integrate with any other tools that meet the needs of your | ||
project. | ||
|
||
== Baseline Fabrications | ||
The Baseline represents the Factory component in the diagram below. aiSSEMBLE leverages | ||
xref:aissemble-approach.adoc#_configurable_tooling[configurable tooling] in the fabrication process to generate key | ||
scaffolding and other components that are tailored to your project. aiSSEMBLE also establishes a build process that | ||
produces deployment-ready artifacts. | ||
|
||
image::aissemble-solution-architecture.png[align="left",width=1366,height=768] | ||
|
||
|
||
[#_configurable_tooling] | ||
=== Configurable Tooling | ||
With the fast-moving landscape of tools and techniques within AI, a process that can quickly change at the speed of AI | ||
is needed. aiSSEMBLE understands it is crucial that the nuances of existing customer environments and preferences can be | ||
incorporated into AI projects as an integral concept. The Baseline’s Configurable Tooling is realized by using | ||
https://www.omg.org/mda/[Model Driven Architecture,role=external,window=_blank] to describe your AI system with simple | ||
JSON files. These files are then ingested to generate Python, Java, Scala, or any other type of file. Configurable | ||
tooling exists for a vast array of components leveraging popular implementation choices, which can be used as-is or | ||
tailored to specific needs. | ||
|
||
=== Reusable Components | ||
Reusable components represent the "ready-to-deploy" artifacts within aiSSEMBLE. These reusable components can be used in | ||
a project directly. These include, but are not limited to, data lineage, AI model versioning, and bias detection. | ||
|
||
== aiSSEMBLE Landscape | ||
aiSSEMBLE is not a platform, but rather a framework that integrates with various technologies. The graphic below | ||
demonstrates the representative set of technologies aiSSEMBLE integrates with. This set is always evolving to | ||
keep pace with the rapidly changing AI space. | ||
|
||
image::aissemble-landscape.png[align="left",width=1366,height=768] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.