... | ... | @@ -14,11 +14,11 @@ This project was initiated in order to revise, improve and enhance the code base |
|
|
### FAMER usage with JSON configuration
|
|
|
FAMER uses a configuration file to define the single tasks like linking and clustering. Those input configuration is based on JSON, the documentation and usage can be find here and will be progressively completed and adapted to the current code.
|
|
|
|
|
|
An executable FAMER JAR can be build with maven in a local `build` directory, see [here](https://git.informatik.uni-leipzig.de/dbs/FAMER/-/wikis/Maven-plugins-checkstyle,-spotbugs-and-shade#maven-shade-plugin-for-jar-building) for how it is build and more information.
|
|
|
An executable FAMER JAR can be build with maven in a local `build` directory, see [here](https://git.informatik.uni-leipzig.de/dbs/FAMER/-/wikis/Maven-plugins-checkstyle,-spotbugs-and-shade#maven-shade-plugin-for-jar-building) for how it is build and more information. Use this JAR to run a Flink job (see [here](https://ci.apache.org/projects/flink/flink-docs-stable/ops/cli.html) or [here](https://ci.apache.org/projects/flink/flink-docs-stable/getting-started/tutorials/local_setup.html) for details). Pass the path to the JSON config file as command line argument, e.g.:
|
|
|
|
|
|
Use this JAR to run a Flink job (see [here](https://ci.apache.org/projects/flink/flink-docs-stable/ops/cli.html) or [here](https://ci.apache.org/projects/flink/flink-docs-stable/getting-started/tutorials/local_setup.html) for details). Pass the path to the JSON config file as command line argument, e.g.:
|
|
|
> `./bin/flink run path/to/famer-0.1.0-SNAPSHOT-executable.jar path/to/famer-config.json`
|
|
|
|
|
|
`./bin/flink run path/to/famer-0.1.0-SNAPSHOT-executable.jar path/to/famer-config.json`
|
|
|
**Note:** Since the configuration is parsed from a JSON file, the following must be considered when using FAMER on Windows systems. File paths on Windows systems file are specified with "backslash" (`\`) , e.g: `C:\path\to\graph`. However, the "backslash" is used as an escape character in JSON format, so the paths provided in the configuration file must be double-escaped in order to be parsed validly: `C:\\path\\to\\graph`.
|
|
|
|
|
|
* [JSON configuration and documentation - overall structure](Overall-Configuration-(JSON))
|
|
|
* [JSON configuration and documentation for famer-preProcessing](PreProcessing-Configuration-(JSON))
|
... | ... | |