Skip to content
This repository was archived by the owner on Mar 7, 2026. It is now read-only.

Commit 037a7d4

Browse files
committed
docs: add note about manually installed LitterBox dependency
1 parent 87cd9a9 commit 037a7d4

2 files changed

Lines changed: 23 additions & 31 deletions

File tree

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,18 @@ To produce an executable JAR file, run the following command:
2424
mvn package
2525
```
2626

27+
> [!NOTE]
28+
> Until LitterBox is published on Maven Central you have to install it from the local Maven cache:
29+
>
30+
> ```bash
31+
> # clone LitterBox in version 1.9
32+
> git clone -b 1.9 https://github.com/se2p/LitterBox
33+
> cd LitterBox
34+
> # install the LitterBox JAR into the local Maven Cache so it can be found in this project
35+
> mvn install -DskipTests
36+
> ```
37+
> Now, the `package` command above should work in this repository.
38+
2739
This will produce `target/embedded-kittens-1.0.full.jar`
2840
2941
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
4658

4759
## Output formats
4860

49-
### Code2vec output
61+
The currently supported formats are suitable for the following models:
62+
63+
- [ASTNN](https://doi.org/10.1109/ICSE.2019.00086)
64+
- [code2vec](https://doi.org/10.1145/3291636)
65+
- [code2seq](https://arxiv.org/abs/1808.01400)
66+
- [GGNN](https://arxiv.org/abs/1711.00740)
67+
- and tokenised sequences for Transformers/LSTM/…
68+
69+
70+
### Example: code2vec output
5071

5172
To be able to use the code2vec model with the programming language Scratch, a scratch parser is needed to generate the required input representation.
5273
According to the description on https://github.com/tech-srl/code2vec#extending-to-other-languages,

pom.xml

Lines changed: 1 addition & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -19,42 +19,13 @@
1919
<java.version>17</java.version>
2020
<maven.compiler.release>17</maven.compiler.release>
2121

22-
<litterbox.version>1.9-20240927.173807-15</litterbox.version>
22+
<litterbox.version>1.9</litterbox.version>
2323
<checkstyle.version>10.18.1</checkstyle.version>
2424

2525
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
2626
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
2727
</properties>
2828

29-
<repositories>
30-
<repository>
31-
<id>gitlab-maven</id>
32-
<!--suppress UnresolvedMavenProperty -->
33-
<url>${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/maven</url>
34-
</repository>
35-
<repository>
36-
<id>gitlab-litterbox</id>
37-
<url>https://gitlab.infosun.fim.uni-passau.de/api/v4/projects/425/packages/maven</url>
38-
</repository>
39-
<repository>
40-
<id>maven_central</id>
41-
<name>Maven Central</name>
42-
<url>https://repo.maven.apache.org/maven2/</url>
43-
</repository>
44-
</repositories>
45-
<distributionManagement>
46-
<repository>
47-
<id>gitlab-maven</id>
48-
<!--suppress UnresolvedMavenProperty -->
49-
<url>${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/maven</url>
50-
</repository>
51-
<snapshotRepository>
52-
<id>gitlab-maven</id>
53-
<!--suppress UnresolvedMavenProperty -->
54-
<url>${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/maven</url>
55-
</snapshotRepository>
56-
</distributionManagement>
57-
5829
<build>
5930
<plugins>
6031
<plugin>

0 commit comments

Comments
 (0)