Skip to content

Commit

Permalink
prep 1.0.0-ALPHA release
Browse files Browse the repository at this point in the history
  • Loading branch information
tballison committed Mar 22, 2019
1 parent e9152d0 commit 656b435
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 21 deletions.
4 changes: 2 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@
<parent>
<groupId>org.mitre.quaerite</groupId>
<artifactId>quaerite-parent</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>1.0.0-ALPHA</version>
<relativePath>quaerite-parent/pom.xml</relativePath>
</parent>

<artifactId>quaerite</artifactId>
<packaging>pom</packaging>
<version>1.0.0-SNAPSHOT</version>
<version>1.0.0-ALPHA</version>

<properties>
<maven.compiler.source>1.8</maven.compiler.source>
Expand Down
4 changes: 2 additions & 2 deletions quaerite-cli/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
<parent>
<groupId>org.mitre.quaerite</groupId>
<artifactId>quaerite-parent</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>1.0.0-ALPHA</version>
<relativePath>../quaerite-parent/pom.xml</relativePath>
</parent>

Expand Down Expand Up @@ -85,7 +85,7 @@
<dependency>
<groupId>org.mitre.quaerite</groupId>
<artifactId>quaerite-connectors</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>1.0.0-ALPHA</version>
<scope>compile</scope>
</dependency>
<dependency>
Expand Down
2 changes: 1 addition & 1 deletion quaerite-connectors/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<parent>
<groupId>org.mitre.quaerite</groupId>
<artifactId>quaerite-parent</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>1.0.0-ALPHA</version>
<relativePath>../quaerite-parent/pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
Expand Down
2 changes: 1 addition & 1 deletion quaerite-core/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<parent>
<groupId>org.mitre.quaerite</groupId>
<artifactId>quaerite-parent</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>1.0.0-ALPHA</version>
<relativePath>../quaerite-parent/pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
Expand Down
26 changes: 13 additions & 13 deletions quaerite-examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Prerequisites
6. Download _tmdb.json_ from
[OpenSourceConnections via AWS](http://o19s-public-datasets.s3.amazonaws.com/tmdb.json).

7. Ingest the _tmdb_ data ```java -jar quaerite-examples-1.0.0-SNAPSHOT.jar tmdb.json http://localhost:8983/solr/tmdb```
7. Ingest the _tmdb_ data ```java -jar quaerite-examples-1.0.0-ALPHA.jar tmdb.json http://localhost:8983/solr/tmdb```

8. Navigate to [here](http://localhost:8983/solr/#/tmdb) to confirm that _tmdb_ was loaded into Solr.

Expand All @@ -60,7 +60,7 @@ You can find the files (such as ```movie_judgments.csv``` and
```experiments.json```) in [this directory](https://github.com/mitre/quaerite/tree/master/quaerite-examples/example_files).


Run some experiments: ```java -jar quaerite-cli-1.0.0-SNAPSHOT.jar RunExperiments -db my_db -j movie_judgments.csv -e experiments.json```
Run some experiments: ```java -jar quaerite-cli-1.0.0-ALPHA.jar RunExperiments -db my_db -j movie_judgments.csv -e experiments.json```

You will find the standard reports in the ```reports/``` directory, including:
* Scores per query -- a score for each query for each experiment
Expand All @@ -81,16 +81,16 @@ Be careful:
* Permutation explosion -- the number of experiments grows factorially with each new parameter
* Overfitting -- this is something to be wary of throughout

1. Generate experiments from the `experiment_features_1.json` file, which generates one experiment per field: ```java -jar quaerite-cli-1.0.0-SNAPSHOT.jar GenerateExperiments -f experiment_features_1.json -e experiments_1.json```
2. Generate experiments from the `experiment_features_2.json` file, which generates experiments with up to two fields: ```java -jar quaerite-cli-1.0.0-SNAPSHOT.jar GenerateExperiments -f experiment_features_2.json -e experiments_2.json```
1. Generate experiments from the `experiment_features_1.json` file, which generates one experiment per field: ```java -jar quaerite-cli-1.0.0-ALPHA.jar GenerateExperiments -f experiment_features_1.json -e experiments_1.json```
2. Generate experiments from the `experiment_features_2.json` file, which generates experiments with up to two fields: ```java -jar quaerite-cli-1.0.0-ALPHA.jar GenerateExperiments -f experiment_features_2.json -e experiments_2.json```
3. Now, let's say you want to test a wider range of fields that include different analyzer chains for the
three fields used so far (`tb_*` and `tss_*`). Further, you'd like to experiment with different weight settings, e.g. `[0.0, 1.0, 5.0, 10.0]`, but
you'd still like to see which single field or pair of fields yields the best results on the ground truth set...
Generate experiments from the `experiment_features_3.json` file: ```java -jar quaerite-cli-1.0.0-SNAPSHOT.jar GenerateExperiments -f experiment_features_3.json -e experiments_3.json```
Generate experiments from the `experiment_features_3.json` file: ```java -jar quaerite-cli-1.0.0-ALPHA.jar GenerateExperiments -f experiment_features_3.json -e experiments_3.json```
4. Finally, let's say you'd like to try all combinations of fields, and you'd like to add in various `tie` values (e.g. `0.0, 0.1, 0.3`),
generate experiments from the `experiment_features_4.json` file: ```java -jar quaerite-cli-1.0.0-SNAPSHOT.jar GenerateExperiments -f experiment_features_4.json -e experiments_4.json```
generate experiments from the `experiment_features_4.json` file: ```java -jar quaerite-cli-1.0.0-ALPHA.jar GenerateExperiments -f experiment_features_4.json -e experiments_4.json```

You can now run the experiments in any one of these experiment files: ```java -jar quaerite-cli-1.0.0-SNAPSHOT.jar RunExperiments -db my_db -j movie_judgments.csv -e experiments_3.json```
You can now run the experiments in any one of these experiment files: ```java -jar quaerite-cli-1.0.0-ALPHA.jar RunExperiments -db my_db -j movie_judgments.csv -e experiments_3.json```

Each time you run the experiments, the results in the ```results/``` directory will be overwritten.

Expand All @@ -114,7 +114,7 @@ as a refresher.

### Running the GA with a seed file
Run the genetic algorithm from the features specification file with the original experiments as the seed:
```java -jar quaerite-cli-1.0.0-SNAPSHOT.jar RunGA -db my_db -j movie_judgments.csv -f experiment_features_4.json -e experiments.json```
```java -jar quaerite-cli-1.0.0-ALPHA.jar RunGA -db my_db -j movie_judgments.csv -f experiment_features_4.json -e experiments.json```
This will run 4-fold cross-validation (`"nFolds" : 4`). It will load the `experiments.json` file as the training seeds.

For each fold, `RunGA` will evaluate the seed experiments on the training portion of the fold:
Expand Down Expand Up @@ -182,7 +182,7 @@ no better than throwing in all the fields with random weights (see below).

### Running the GA with a random seed
As before, run the `GA` with `experiment_features_4.json`:
```java -jar quaerite-cli-1.0.0-SNAPSHOT.jar RunGA -db my_db -j movie_judgments.csv -f experiment_features_4.json```
```java -jar quaerite-cli-1.0.0-ALPHA.jar RunGA -db my_db -j movie_judgments.csv -f experiment_features_4.json```

### Running the GA with different GA parameters
As you can see in the `gaConfig` element in `experiment_features_5.json`,
Expand All @@ -191,12 +191,12 @@ the settings for the `crossoverProbability`, `mutationProbability`,
from `experiment_features_4.json`; these settings are more conservative.

Now run the `GA` with these different GA parameters:
```java -jar quaerite-cli-1.0.0-SNAPSHOT.jar RunGA -db my_db -j movie_judgments.csv -f experiment_features_5.json```
```java -jar quaerite-cli-1.0.0-ALPHA.jar RunGA -db my_db -j movie_judgments.csv -f experiment_features_5.json```

### Running the GA with custom train/test sets
Users may want to control the train/test split and turn off the cross-validation.
To do this, specify `-train train.csv` and `-test test.csv` instead of `-j judgments.csv`, as in:
```java -jar quaerite-cli-1.0.0-SNAPSHOT.jar RunGA -db my_db -train movie_judgments_train.csv -test movie_judgments_test.csv -f experiment_features_5.json```
```java -jar quaerite-cli-1.0.0-ALPHA.jar RunGA -db my_db -train movie_judgments_train.csv -test movie_judgments_test.csv -f experiment_features_5.json```

_Quaerite_ -- Finding Features
-----------------------------
Expand All @@ -218,7 +218,7 @@ your truth set may reveal or contain.

### Finding Features
Run FindFeatures and specify which fields are your facetable fields with the ```-f``` flag:
```java -jar quaerite-cli-1.0.0-SNAPSHOT.jar FindFeatures -db my_db -j movie_judgments.csv -s http://localhost:8983/solr/tmdb -f genres_facet,original_language_facet,production_companies_facet```
```java -jar quaerite-cli-1.0.0-ALPHA.jar FindFeatures -db my_db -j movie_judgments.csv -s http://localhost:8983/solr/tmdb -f genres_facet,original_language_facet,production_companies_facet```

For each facet, the results are sorted by the descending order of contrast value.
For example:
Expand Down Expand Up @@ -272,7 +272,7 @@ _Quaerite_ -- Examining the Database
-------------------------------------
_Quaerite_ relies on an in-process H2 database. To view the contents:

```java -jar quaerite-cli-1.0.0-SNAPSHOT.jar StartDB```
```java -jar quaerite-cli-1.0.0-ALPHA.jar StartDB```

Navigate in a browser to: `http://localhost:8082`

Expand Down
2 changes: 1 addition & 1 deletion quaerite-examples/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
<parent>
<groupId>org.mitre.quaerite</groupId>
<artifactId>quaerite-parent</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>1.0.0-ALPHA</version>
<relativePath>../quaerite-parent/pom.xml</relativePath>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion quaerite-parent/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

<groupId>org.mitre.quaerite</groupId>
<artifactId>quaerite-parent</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>1.0.0-ALPHA</version>
<packaging>pom</packaging>

<name>Quaerite parent</name>
Expand Down

0 comments on commit 656b435

Please sign in to comment.