docs: add note about manually installed LitterBox dependency

se2p · Oct 9, 2024 · 037a7d4 · 037a7d4
1 parent 87cd9a9
commit 037a7d4
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -24,6 +24,18 @@ To produce an executable JAR file, run the following command:
 mvn package
 ```
 
+> [!NOTE]
+> Until LitterBox is published on Maven Central you have to install it from the local Maven cache:
+> 
+> ```bash
+> # clone LitterBox in version 1.9
+> git clone -b 1.9 https://github.com/se2p/LitterBox
+> cd LitterBox
+> # install the LitterBox JAR into the local Maven Cache so it can be found in this project
+> mvn install -DskipTests
+> ```
+> Now, the `package` command above should work in this repository.
+
 This will produce `target/embedded-kittens-1.0.full.jar`
 
 Pre-built JARs are also available for each release on GitHub.
@@ -46,7 +58,16 @@ java -jar embedded-kittens-1.0.full.jar code2vec --help
 
 ## Output formats
 
-### Code2vec output
+The currently supported formats are suitable for the following models:
+
+- [ASTNN](https://doi.org/10.1109/ICSE.2019.00086)
+- [code2vec](https://doi.org/10.1145/3291636)
+- [code2seq](https://arxiv.org/abs/1808.01400)
+- [GGNN](https://arxiv.org/abs/1711.00740)
+- and tokenised sequences for Transformers/LSTM/…
+
+
+### Example: code2vec output
 
 To be able to use the code2vec model with the programming language Scratch, a scratch parser is needed to generate the required input representation.
 According to the description on https://github.com/tech-srl/code2vec#extending-to-other-languages,

diff --git a/pom.xml b/pom.xml
@@ -19,42 +19,13 @@
         <java.version>17</java.version>
         <maven.compiler.release>17</maven.compiler.release>
 
-        <litterbox.version>1.9-20240927.173807-15</litterbox.version>
+        <litterbox.version>1.9</litterbox.version>
         <checkstyle.version>10.18.1</checkstyle.version>
 
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
     </properties>
 
-    <repositories>
-        <repository>
-            <id>gitlab-maven</id>
-            <!--suppress UnresolvedMavenProperty -->
-            <url>${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/maven</url>
-        </repository>
-        <repository>
-            <id>gitlab-litterbox</id>
-            <url>https://gitlab.infosun.fim.uni-passau.de/api/v4/projects/425/packages/maven</url>
-        </repository>
-        <repository>
-            <id>maven_central</id>
-            <name>Maven Central</name>
-            <url>https://repo.maven.apache.org/maven2/</url>
-        </repository>
-    </repositories>
-    <distributionManagement>
-        <repository>
-            <id>gitlab-maven</id>
-            <!--suppress UnresolvedMavenProperty -->
-            <url>${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/maven</url>
-        </repository>
-        <snapshotRepository>
-            <id>gitlab-maven</id>
-            <!--suppress UnresolvedMavenProperty -->
-            <url>${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/maven</url>
-        </snapshotRepository>
-    </distributionManagement>
-
     <build>
         <plugins>
             <plugin>