Docs, functions, and embeddings

[JamesMonk]

---

title: "pr: " labels: "Pull request"

Description

This overhauls the documentation to a version 1 standard prior to github push. Files added / modified:

README: This file summarizes and links to the files below.

docs/01_thethingstore: This file is background and mental framework

docs/02_usethingstore: This file introduces a simple example which shows basic usage of the the thing store.

docs/03_thingstoredatastructures: This file collects the different data structures used within the thing store at a high level.)

docs/04_processdesign: This file introduces simple thoughts surrounding process design and refinement.

docs/05_butwhy: This file talks about process automation, why it's hard, and how the ThingStore solves that.

docs/06_planning_and_roadmapping: Roadmap of functionality and changes.

docs/data_structures/00_things: This file introduces the Thing and ThingStore data structures and lists the components .)

docs/data_structures/01_atomicity: This file introduces the concept of atomic v complex and lists the atomic types.

docs/data_structures/02a_components: This file details and links to the components

docs/data_structures/02b_components_metadata: This file details the structure of the metadata component of a Thing

docs/data_structures/02c_components_dataset: This file details the structure of the dataset component of a Thing

docs/data_structures/02d_components_parameters: This file details the structure of the parameters component of a Thing

docs/data_structures/02e_components_function: This file details the structure of the function component of a Thing.

docs/data_structures/02f_components_metrics: This file details the structure of the metrics component of a Thing

docs/data_structures/02g_components_embedding: This file details the structure of the embedding component of a Thing.

docs/data_structures/02h_components_artifacts: This file details the structure of the artifacts component of a Thing.

docs/data_structures/03_graphs: This file summarizes the graphical nature of Things and includes an image of what a single Thing looks like.

docs/data_structures/04_pointers: This file intimates towards what pointers should be capable of (UNFINISHED - Need to clean wording and insert more thoughts / pictures.)

docs/data_structures/05_thingstore: This file details the structure of a ThingStore (UNFINISHED - Need to clean wording and insert pictures.)

src/thethingstore/init.py: Removing conditional imports at package start. (##TODO MOVE TO LOADING / BREAK INTELLIGENTLY.)

src/thethingstore/file_id.py: Minor changes to accommodate the doc updates and improve clarity.

src/thethingstore/thing_components.py: Minor changes to accommodate the doc updates.

src/thethingstore/thing_node.py: Add ThingNode class w/ helper util.

src/thethingstore/thing_graph.py: Add ThingGraph class w/ helper util.

src/thethingstore/thing_store_log.py: Minor changes to accommodate the doc updates, functions, and embeddings.

src/thethingstore/thing_store_pa_fs.py: Minor changes to accommodate the doc updates, functions, and embeddings.

src/thethingstore/thing_store_base.py: Minor changes to accommodate the doc updates, functions, and embeddings.

src/thethingstore/thing_store_mlflow.py: Removing POC.

src/thethingstore/api/load.py: Changes to accommodate functions and embeddings.

src/thethingstore/api/save.py: Changes to accommodate functions and embeddings.

src/types.py: Minor changes to accommodate the doc updates.

notebooks/TheLanguageOfThings_1_3.ipynb: This file introduces 'the language of Things' to help set the stage for understanding why specific elements of the next notebook are included.

notebooks/TheLanguageOfThings_2_3.ipynb: This file introduces and simulates a notional project, then uses the ThingStore to do neat stuff with it!

notebooks/FunctionalThing.ipynb: This file introduces functions!

notebooks/stepfunctions.py: These are reused in TheLanguageOfThings notebook.

.gitignore: Ignoring potentially dumped local artifacts.

Type of change

Please delete options that are not relevant.

• [x] New feature (non-breaking change which adds functionality)

Checklist:

• [x] My code follows the style guidelines of this project
• [x] I have performed a self-review of my own code
• [x] I have commented my code, particularly in hard-to-understand areas
• [x] I have made corresponding changes to the documentation
• [x] My changes generate no new warnings
• [x] I have added tests that prove my fix is effective or that my feature works
• [x] New and existing unit tests pass locally with my changes
• [x] Any dependent changes have been merged and published in downstream modules

[JamesMonk]

@LunarEngineerSF Hey Tim, these are you docs changes here in github. As soon as you approve this, I can merge them in.

[JamesMonk]

Additionally, I did not include the notebooks as I was unsure if the metadata was safe from sensitive information. I see there are AWS account numbers in there at least, and I don't know what the sensitivity of that is.

[LunarEngineerSF]

I'm going to put some time on my calendar today to get the examples swapped to a format that doesn't retain the Notebook metadata in order to avoid that particular issue. After I get those in place I'll approve!

[JamesMonk]

@LunarEngineerSF This should be good to go.

[LunarEngineerSF]

There's some minor inconsistencies in the docs (may fault 😄) for embed (says not implemented yet) but I don't think that is sufficient to prevent this from happening.

Let's do it!

[LunarEngineerSF]

@JamesMonk want to pull the trigger?