From 7bea71876dda5587fae82ff6d1357267be53ba3c Mon Sep 17 00:00:00 2001
From: Javier Toledo <javier@theagilemonkeys.com>
Date: Wed, 30 Aug 2023 13:13:40 +0100
Subject: [PATCH] Removed embeddings arithmetics from documentation.

Also removed `.idea/workspace.xml` from git tracking and gitignored it, as it's an user-specific IDE file
---
 .gitignore                                    |   1 +
 .idea/workspace.xml                           | 149 ------------------
 .../docs/03_components/02_embeddings_space.md |  79 ----------
 3 files changed, 1 insertion(+), 228 deletions(-)
 delete mode 100644 .idea/workspace.xml

diff --git a/.gitignore b/.gitignore
index 5da6bb0..2d8cf21 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,6 +5,7 @@ build/
 !**/src/test/**/build/
 
 ### IntelliJ IDEA ###
+.idea/workspace.xml
 .idea/modules.xml
 .idea/jarRepositories.xml
 .idea/compiler.xml
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
deleted file mode 100644
index 896c842..0000000
--- a/.idea/workspace.xml
+++ /dev/null
@@ -1,149 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="AutoImportSettings">
-    <option name="autoReloadType" value="SELECTIVE" />
-  </component>
-  <component name="ChangeListManager">
-    <list default="true" id="9cad3848-1525-4d25-a87c-214202721c5d" name="Changes" comment="">
-      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/core/src/main/java/com/theagilemonkeys/ellmental/core/schema/Embedding.java" beforeDir="false" afterPath="$PROJECT_DIR$/core/src/main/java/com/theagilemonkeys/ellmental/core/schema/Embedding.java" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/docs-site/docs/03_components/01_core_abstractions.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs-site/docs/03_components/01_core_abstractions.md" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/docs-site/docs/03_components/02_embeddings_space.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs-site/docs/03_components/02_embeddings_space.md" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/examples/simplejava/src/main/java/com/theagilemonkeys/ellmental/helloworld/Main.java" beforeDir="false" afterPath="$PROJECT_DIR$/examples/simplejava/src/main/java/com/theagilemonkeys/ellmental/helloworld/Main.java" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/modules/embeddingsgeneration/src/main/java/com/theagilemonkeys/ellmental/embeddingsgeneration/EmbeddingsGenerationModel.java" beforeDir="false" afterPath="$PROJECT_DIR$/modules/embeddingsgeneration/src/main/java/com/theagilemonkeys/ellmental/embeddingsgeneration/EmbeddingsGenerationModel.java" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/modules/embeddingsgeneration/src/main/java/com/theagilemonkeys/ellmental/embeddingsgeneration/openai/OpenAIEmbeddingsModel.java" beforeDir="false" afterPath="$PROJECT_DIR$/modules/embeddingsgeneration/src/main/java/com/theagilemonkeys/ellmental/embeddingsgeneration/openai/OpenAIEmbeddingsModel.java" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/modules/embeddingsgeneration/src/test/java/com/theagilemonkeys/ellmental/embeddingsgeneration/openai/OpenAIEmbeddingsModelTest.java" beforeDir="false" afterPath="$PROJECT_DIR$/modules/embeddingsgeneration/src/test/java/com/theagilemonkeys/ellmental/embeddingsgeneration/openai/OpenAIEmbeddingsModelTest.java" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/modules/embeddingsstore/src/main/java/com/theagilemonkeys/ellmental/embeddingsstore/EmbeddingsStore.java" beforeDir="false" afterPath="$PROJECT_DIR$/modules/embeddingsstore/src/main/java/com/theagilemonkeys/ellmental/embeddingsstore/EmbeddingsStore.java" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/modules/embeddingsstore/src/main/java/com/theagilemonkeys/ellmental/embeddingsstore/pinecone/PineconeEmbeddingsStore.java" beforeDir="false" afterPath="$PROJECT_DIR$/modules/embeddingsstore/src/main/java/com/theagilemonkeys/ellmental/embeddingsstore/pinecone/PineconeEmbeddingsStore.java" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/modules/embeddingsstore/src/main/java/com/theagilemonkeys/ellmental/embeddingsstore/pinecone/QueryVectorResponseSchema.java" beforeDir="false" afterPath="$PROJECT_DIR$/modules/embeddingsstore/src/main/java/com/theagilemonkeys/ellmental/embeddingsstore/pinecone/QueryVectorResponseSchema.java" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/modules/embeddingsstore/src/main/java/com/theagilemonkeys/ellmental/embeddingsstore/pinecone/UpsertVectorSchema.java" beforeDir="false" afterPath="$PROJECT_DIR$/modules/embeddingsstore/src/main/java/com/theagilemonkeys/ellmental/embeddingsstore/pinecone/UpsertVectorSchema.java" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/modules/embeddingsstore/src/test/java/com/theagilemonkeys/ellmental/embeddingsstore/pinecone/PineconeEmbeddingsStoreTest.java" beforeDir="false" afterPath="$PROJECT_DIR$/modules/embeddingsstore/src/test/java/com/theagilemonkeys/ellmental/embeddingsstore/pinecone/PineconeEmbeddingsStoreTest.java" afterDir="false" />
-    </list>
-    <option name="SHOW_DIALOG" value="false" />
-    <option name="HIGHLIGHT_CONFLICTS" value="true" />
-    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
-    <option name="LAST_RESOLUTION" value="IGNORE" />
-  </component>
-  <component name="ExternalProjectsData">
-    <projectState path="$PROJECT_DIR$">
-      <ProjectState />
-    </projectState>
-  </component>
-  <component name="ExternalProjectsManager">
-    <system id="GRADLE">
-      <state>
-        <task path="$PROJECT_DIR$">
-          <activation />
-        </task>
-        <projects_view>
-          <tree_state>
-            <expand>
-              <path>
-                <item name="" type="6a2764b6:ExternalProjectsStructure$RootNode" />
-                <item name="eLLMental" type="f1a62948:ProjectNode" />
-              </path>
-            </expand>
-            <select />
-          </tree_state>
-        </projects_view>
-      </state>
-    </system>
-  </component>
-  <component name="Git.Settings">
-    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
-  </component>
-  <component name="MarkdownSettingsMigration">
-    <option name="stateVersion" value="1" />
-  </component>
-  <component name="ProblemsViewState">
-    <option name="selectedTabId" value="ProjectErrors" />
-  </component>
-  <component name="ProjectId" id="2Thv794LljpJB6whwEafjMfg13O" />
-  <component name="ProjectLevelVcsManager" settingsEditedManually="true" />
-  <component name="ProjectViewState">
-    <option name="hideEmptyMiddlePackages" value="true" />
-    <option name="showLibraryContents" value="true" />
-  </component>
-  <component name="PropertiesComponent">{
-  &quot;keyToString&quot;: {
-    &quot;RunOnceActivity.OpenProjectViewOnStart&quot;: &quot;true&quot;,
-    &quot;RunOnceActivity.ShowReadmeOnStart&quot;: &quot;true&quot;,
-    &quot;SHARE_PROJECT_CONFIGURATION_FILES&quot;: &quot;true&quot;,
-    &quot;TODO_SCOPE&quot;: &quot;All Places&quot;,
-    &quot;WebServerToolWindowFactoryState&quot;: &quot;false&quot;,
-    &quot;git-widget-placeholder&quot;: &quot;main&quot;,
-    &quot;jdk.selected.JAVA_MODULE&quot;: &quot;openjdk-20&quot;,
-    &quot;last_opened_file_path&quot;: &quot;/Users/javier/projects/eLLMental&quot;,
-    &quot;node.js.detected.package.eslint&quot;: &quot;true&quot;,
-    &quot;node.js.detected.package.tslint&quot;: &quot;true&quot;,
-    &quot;node.js.selected.package.eslint&quot;: &quot;(autodetect)&quot;,
-    &quot;node.js.selected.package.tslint&quot;: &quot;(autodetect)&quot;,
-    &quot;nodejs_package_manager_path&quot;: &quot;npm&quot;,
-    &quot;settings.editor.selected.configurable&quot;: &quot;preferences.pluginManager&quot;,
-    &quot;vue.rearranger.settings.migration&quot;: &quot;true&quot;
-  }
-}</component>
-  <component name="RecentsManager">
-    <key name="CopyFile.RECENT_KEYS">
-      <recent name="$PROJECT_DIR$" />
-      <recent name="$PROJECT_DIR$/docs-site/src" />
-      <recent name="$PROJECT_DIR$/docs-site/docs" />
-      <recent name="$PROJECT_DIR$/docs-site/static/img" />
-    </key>
-  </component>
-  <component name="RunManager">
-    <configuration name="eLLMental [build]" type="GradleRunConfiguration" factoryName="Gradle" nameIsGenerated="true">
-      <ExternalSystemSettings>
-        <option name="executionName" />
-        <option name="externalProjectPath" value="$PROJECT_DIR$" />
-        <option name="externalSystemIdString" value="GRADLE" />
-        <option name="scriptParameters" value="--scan" />
-        <option name="taskDescriptions">
-          <list />
-        </option>
-        <option name="taskNames">
-          <list>
-            <option value="build" />
-          </list>
-        </option>
-        <option name="vmOptions" />
-      </ExternalSystemSettings>
-      <ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
-      <ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
-      <EXTENSION ID="com.intellij.execution.ExternalSystemRunConfigurationJavaExtension">
-        <extension name="net.ashald.envfile">
-          <option name="IS_ENABLED" value="false" />
-          <option name="IS_SUBST" value="false" />
-          <option name="IS_PATH_MACRO_SUPPORTED" value="false" />
-          <option name="IS_IGNORE_MISSING_FILES" value="false" />
-          <option name="IS_ENABLE_EXPERIMENTAL_INTEGRATIONS" value="false" />
-          <ENTRIES>
-            <ENTRY IS_ENABLED="true" PARSER="runconfig" IS_EXECUTABLE="false" />
-          </ENTRIES>
-        </extension>
-      </EXTENSION>
-      <DebugAllEnabled>false</DebugAllEnabled>
-      <ForceTestExec>false</ForceTestExec>
-      <method v="2" />
-    </configuration>
-  </component>
-  <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
-  <component name="TaskManager">
-    <task active="true" id="Default" summary="Default task">
-      <changelist id="9cad3848-1525-4d25-a87c-214202721c5d" name="Changes" comment="" />
-      <created>1691507959181</created>
-      <option name="number" value="Default" />
-      <option name="presentableId" value="Default" />
-      <updated>1691507959181</updated>
-      <workItem from="1691507960273" duration="17280000" />
-      <workItem from="1691687224885" duration="6374000" />
-      <workItem from="1692634591758" duration="494000" />
-      <workItem from="1693322245615" duration="4859000" />
-      <workItem from="1693327144223" duration="2385000" />
-    </task>
-    <servers />
-  </component>
-  <component name="TypeScriptGeneratedFilesManager">
-    <option name="version" value="3" />
-  </component>
-</project>
\ No newline at end of file
diff --git a/docs-site/docs/03_components/02_embeddings_space.md b/docs-site/docs/03_components/02_embeddings_space.md
index 285b6e2..94ab11a 100644
--- a/docs-site/docs/03_components/02_embeddings_space.md
+++ b/docs-site/docs/03_components/02_embeddings_space.md
@@ -96,85 +96,6 @@ List<Embedding> closestNeighbors = embeddingsSpace.mostSimilarEmbeddings(embeddi
 // closestNeighbors will contain the embeddings for "Hello, eLLMental!" and "Hello, world!"
 ```
 
-## `calculateRelationshipVector`
-
-Computes a relationship vector for provided text pairs (To be used with the `translateEmbedding` method)
-
-- **Parameters**:
-    - `textPairs`: Array of text pairs.
-
-For instance, with the following list of text pairs:
-
-| Text 1 | Text 2 |
-|--------|--------|
-| Man    | Woman  |
-| Boy    | Girl   |
-| King   | Queen  |
-| Prince | Princess |
-| Father | Mother |
-
-The relationship vector for this group represents a translation in the embeddings space that, given a word that matches the ones in the left column, provides the location of a word that would likely appear in the right column for the given word. See the documentation for [`translateEmbedding`](#translateEmbedding) for more details.
-
-The `RelationshipVector` class is defined as follows:
-
-```java
-public class RelationshipVector {
-    public final String label;
-    public final float[] vector;
-}
-```
-
-And it can be calculated like this:
-
-```java
-String[][] textPairs = [["Man", "Woman"], ["Boy", "Girl"], ["King", "Queen"], ["Prince", "Princess"], ["Father", "Mother"]];
-RelationshipVector relationshipVector = embeddingsSpace.calculateRelationshipVector(textPairs);
-```
-
-## `storeNamedRelationshipVector`
-
-Stores a relationship vector in the embeddings store and assigns it a label for later use.
-
-- **Parameters**:
-    - `label`: The label to assign to the relationship vector.
-    - `relationshipVector`: The relationship vector to store.
-    
-
-```java
-// First we calculate a relationship vector
-RelationshipVector relationshipVector = embeddingsSpace.calculateRelationshipVector(textPairs);
-
-// Then we store it in the embeddings store for future use
-embeddingsSpace.storeNamedRelationshipVector("feminize", relationshipVector);
-```
-
-## `translateEmbedding`
-
-Shifts a reference text embedding in the embeddings space to find the location of the text that would meet the relationship represented by the vector.
-
-- **Parameters**:
-    - `referenceText`: The primary embedding.
-    - `vector`: The vector determining translation.
-
-This is useful if you want to search for embeddings that are similar to a given one, but in a different context. For instance, let's say we have the following embedding:
-
-And a relationship vector calculated with the `calculateRelationshipVector` method as follows:
-
-```java
-String[][] textPairs = [["Man", "Woman"], ["Boy", "Girl"], ["King", "Queen"], ["Prince", "Princess"], ["Father", "Mother"]];
-RelationshipVector relationshipVector = embeddingsSpace.calculateRelationshipVector(textPairs);
-```
-
-We can use the relationship vector to find the location of the words that would be similar to "Cow" instead of "Bull". Notice that embeddings cannot be reversed, and we can't really know if this embedding represents a cow, but it will give us a good approximation that can be used to refine search results later.
-
-```java
-// This will create an estimated embedding of the word "Cow"
-Embedding likelyACowEmbedding = embeddingsSpace.translateEmbedding("Bull", relationshipVector);
-
-// We use it as any other embedding to find stored texts that are similar to "Cow"
-List<Embedding> similarToCowEmbeddings = embeddingsSpace.mostSimilarEmbeddings(likelyACowEmbedding, 5);
-```
-
 ## `get`
 
 Retrieves an embedding from the embeddings store using its ID.