You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/blobs.md
+10-12Lines changed: 10 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,14 @@
1
1
# Data `BlobEntry=>Blob`
2
2
3
-
Many `BlobEntry`s from various location can all reference the same large and heavy binary data `Blob`. Furthermore, this system allows a distributed usage over a large networked system.
3
+
Many `BlobEntry`s from various nodes in the graph can reference the `Blob`. A blob is simply just binary data that is uniquely identified through a uuid. This approach allows for distributed usage over a large networked system including limited connectivity situations.
4
4
5
5
:::{tip}
6
-
`Blob`s are separate from `BlobEntry`s. Various nodes on the graph can have any number of `BlobEntry`s (including duplicates), but the user does not necessary have the need to pull the bandwidth heavy blobs across all parts of the system network.
6
+
`BlobEntry`s and `Blob`s are separate separate by related objects. Various nodes on the graph can have any number of `BlobEntry`s (except for duplicate `blobentry.labels`). A user more likely to work the `BlobEntry`s, and only pull bandwidth heavy binary `Blob`s to differemt parts of the system network when needed. Similarly, these data blobs can be readily cached across the network, since blobs are immutable.
7
7
:::
8
8
9
-
## What is a `BlobEntry`
9
+
## What is a `BlobEntry`
10
10
11
-
Additional (large) data attached to variables exist in a few different ways. The primary method for storing additional large data as a `Blob`, however, a blob just "barcoded" binary blob. we use `BlobEntry`s to organize, find, share, distribute, make available and useful across the divergent network how a `Blob` is associated with the graph.
12
-
13
-
A blob entry is small about of structed data that holds reference information to find an actual binary blob which is possibly a massive amount of data.
11
+
A blob entry is a small amount of structed data that holds reference information to find an actual binary blob which is possibly a massive amount of data. `BlobEntry`s are plentiful, lightweight, and allow users to more easily organize, find, share, distribute, the contextual information about a data blob over a divergent network how a `Blob` is associated with the graph. The primary method for storing additional large data as a `Blob`, however, a blob just "barcoded" binary blob of data with little context or meaning.
14
12
15
13
### Listing BlobEntries on a Node
16
14
@@ -46,7 +44,7 @@ The entry object is well structured
46
44
47
45
A binary `Blob` is basically just a "barcoded" piece of data that can be associated (via individual `BlobEntry`s) multiple times across multiple graph nodes, sessions, or robots.
48
46
49
-
Data blobs can be fetched via, e.g. using the unique `.blobId` as primary (or `.originId` as secondary) reference. Also note that the blob itself may also be replicated across any number of blob stores, depending on the application:
47
+
Data blobs can be fetched using the unique `.blobId` as primary (or `.originId` as secondary) reference. Also note that the blob itself may also be replicated across any number of blob stores, depending on the application:
50
48
```python
51
49
blob = getBlob(fgclient, entry.blobId]; checkhash=false) # legacy versions did not use .hash check
Depending on the blob store, it may also be possible to retrieve a blob using the `.originId` rather than `.blobId`.
62
-
:::
63
-
64
58
:::{tip}
65
59
A blob is owned by a `user` and only accessible by other users if allowed via approved roles or permissions.
66
60
:::
@@ -72,7 +66,7 @@ A blob is owned by a `user` and only accessible by other users if allowed via ap
72
66
## Adding BlobEntries
73
67
74
68
:::{warning}
75
-
Adding `Blob` or `BlobEntry`s from the Python SDK are under construction and expected to be part of the v0.6.1 release. This functionality has already been released with the JuliaLang SDK.
69
+
Adding `Blob` or `BlobEntry`s from the Python SDK are under construction and [expected to be part of the v0.6.1 release](https://github.com/NavAbility/NavAbilitySDK.py/milestone/6). This functionality has already been released with the JuliaLang SDK.
76
70
:::
77
71
78
72
Blobs can be linked to any variable (future node) in the graph. This is easily done by adding a BlobEntry:
Adding `Blob` or `BlobEntry`s from the Python SDK are under construction and [expected to be part of the v0.6.1 release](https://github.com/NavAbility/NavAbilitySDK.py/milestone/6). This functionality has already been released with the JuliaLang SDK.
Copy file name to clipboardExpand all lines: docs/factors.md
+21-18Lines changed: 21 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,32 +6,35 @@ Factors represent the interaction between particular variables. Factors define t
6
6
7
7
All factors in a graph can be listed via:
8
8
```python
9
-
flbls =await listFactors(client, context)
9
+
flbls = listFactors(fgclient)
10
+
# flbls = await listFactorsAsync(fgclient)
10
11
# ["x0f_8ebc", ...]
11
12
```
12
13
13
-
Note the factor labels are autogenerated based on the variables and a random sequence. For example a prior factor might have the label `x0f_8ebc`, while factor between three variables might be `x7x49l4f_654t`.
14
+
```{eval-rst}
15
+
.. autofunction:: navability.services.listFactors
16
+
17
+
**Note** the factor labels are autogenerated based on the variables and a random sequence. For example a prior factor might have the label `x0f_8ebc`, while factor between three variables might be `x7x49l4f_654t`.
14
18
15
19
A specific factor can be retrieved using the label:
The NavAbilityApp can also visualize a specific factor graph session, and a convenient link generator can be used to simplify the session filtering criteria:
37
40
```python
@@ -53,7 +56,7 @@ The NavAbilityApp Graph visualization page can also be found in the hamburger me
0 commit comments