.. index:: Inline Networks;
.. _inline-networks:

Inline Networks
===============

If you have your own model-builder and would like to skip many calls to Graphene's :doc:`Data API </data_api/overview>`
to recreate it for analysis, you can convert your model to an `InlineNetwork <../api_reference.html#are-v1-data_management-InlineNetwork>`__,
upload the `InlineNetwork` to S3, and then submit the S3 URI as the `network_uri` in a `NetworkAnalysisRequest <../api_reference.html#are-v1-analysis-NetworkAnalysisRequest>`__.

.. note::

  Inline Networks cannot be combined with other network types (references or traversal queries) as part of a single NetworkAnalysisRequest

Managing IDs and Revisions
--------------------------

Inline Networks are composed of Inline Nodes and Inline Links. Each of these must have a reference (`NodeReference or `LinkReference`).
The reference represents the node's or link's primary key, and cannot be re-used within the element type within one `InlineNetwork`.
If you define a node with `NodeReference(id=1, revision=1)`, you cannot define another node with both `id=1` and `revision=1`.

If you supply a NetworkAnalysisStreamRequest with multiple NetworkAnalysisRequest, each with inline networks, then
the same primary key (NodeReference/LinkReference) definition can appear across the networks, but the definitions must be
consistent. If `NodeReference(id=1, revision=1)` has differing properties across networks, you will see a ValidationError.