Skip to content

Commit 52d2cc1

Browse files
committed
Update README.md and CHANGELOG.md
1 parent 6c262d3 commit 52d2cc1

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
1111
### Changed
1212

1313
* The `{DFA,Mealy,}W{p,}MethodEQOracle(MembershipOracle, int, int)` constructor no longer interprets its second `int` parameter as the batch size, but as an estimate for the expected SUL size. In order to explicitly set the batch size of the oracle, use the `{DFA,Mealy,}W{p,}MethodEQOracle(MembershipOracle, int, int, int)` constructor. Now, the two parameters `lookahead` and `expectedSize` will determine the length of the *middle part* via `Math.max(lookahead, expectedSize - hypothesis.size())`. This allows to dynamically adjust the length of the *middle part* throughout the learning process. See [LearnLib/automatalib#32](https://github.com/LearnLib/automatalib/issues/32).
14-
* Several DFA/Mealy specific (oracle) subclasses are now automatically generated. As a result they are no longer an inner class, but an independent top-level class. This requires to update the import statements.
14+
* Several DFA/Mealy specific (oracle) subclasses are now automatically generated. As a result they are no longer an inner class but an independent top-level class. This requires to update the import statements.
1515
* JSR305 annotations have been replaced with checker-framework annotations.
1616
* LearnLib (incl. AutomataLib) now follows checker-framework's convention that (non-annotated) types are usually considered non-null unless explicitly annotated with `@Nullable`.
1717
* LearnLib (incl. AutomataLib) no longer has a (runtime-) dependency on JSR305 (and other `javax.*`) annotations or includes them in the distribution artifact. This now makes LearnLib (incl. AutomataLib) compliant with [Oracle's binary code license](https://www.oracle.com/downloads/licenses/binary-code-license.html) and allows LearnLib (incl. AutomataLib) artifacts as-is to be bundled in binary distributions with Oracle's JDKs/JREs.
1818
* A lot of code for inferring partial Mealy machines (esp. `PartialLStarMealy` and `PartialObservationTable`) has been removed/refactored. The concept of state local inputs is now implemented as a SUL filter and introduces a special `StateLocalInputSULOracle` which early-answers queries that would traverse unavailable inputs with a previously specified symbol. This way, queries that would traverse undefined input symbols still won't be executed on the SUL but the SUL appears as a 'total' Mealy system to the learner, allowing one to use every currently existing Mealy learner as-is. See the in-tree examples for more information.
1919
* `SULCache` no longer implements `MembershipOracle`.
20+
* Switched to [AutomataLib 0.9.0](https://github.com/LearnLib/automatalib/releases/tag/automatalib-0.9.0)
2021

2122
### Removed
2223

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,14 @@ Additionally, LearnLib offers a variety of tools to ease the practical applicati
3333
This includes drivers and mappers for interfacing software systems with the LearnLib API as well as caches and parallelization for improving the overall performance of the learning setup.
3434
Also, more nuanced setups such as Black-Box-Checking (via [LTSMin][ltsmin]) or inferring partial machines are possible.
3535

36-
While we strive to deliver code at a high quality, please note, that there exist parts of the library that still need thorough testing.
36+
While we strive to deliver code at a high quality, please note that there exist parts of the library that still need thorough testing.
3737
Contributions -- whether it is in the form of new features, better documentation or tests -- are welcome.
3838

3939
## Build Instructions
4040

41-
For simply using LearnLib, you may use the Maven artifacts which are available in the [Maven Central repository][maven-central].
42-
It is also possible to download a bundled [distribution artifact][maven-central-distr], if you want to use LearnLib without Maven support.
43-
Note, that LearnLib requires Java 8.
41+
For simply using LearnLib you may use the Maven artifacts which are available in the [Maven Central repository][maven-central].
42+
It is also possible to download a bundled [distribution artifact][maven-central-distr] if you want to use LearnLib without Maven support.
43+
Note that LearnLib requires Java 8 or newer.
4444

4545
#### Building development versions
4646

@@ -52,7 +52,7 @@ git clone -b develop --single-branch https://github.com/LearnLib/learnlib.git
5252
```
5353

5454
and run a single `mvn clean install`.
55-
This will build all the required maven artifacts and will install them in your local Maven repository, so that you can reference them in other projects.
55+
This will build all the required maven artifacts and will install them in your local Maven repository so that you can reference them in other projects.
5656

5757
If you plan to use a development version of LearnLib in an environment where no Maven support is available, simply run `mvn clean package -Pbundles`.
5858
The respective JARs are then available under `distribution/target/bundles`.
@@ -62,12 +62,12 @@ For building development versions of AutomataLib, see the corresponding document
6262

6363
#### Developing LearnLib
6464

65-
For developing the code base of LearnLib, it is suggested to use one of the major Java IDEs, which come with out-of-the-box Maven support.
65+
For developing the code base of LearnLib it is suggested to use one of the major Java IDEs which come with out-of-the-box Maven support.
6666

6767
* For [IntelliJ IDEA][intellij]:
6868
1. Select `File` -> `New` -> `Project from existing sources` and select the folder containing the development checkout.
6969
1. Choose "Import Project from external model", select "Maven" and click `Next`.
70-
1. Configure the project to your liking, but make sure to check "Import Maven projects automatically" and have "Generated sources folders" set to "Detect automatically".
70+
1. Configure the project to your liking but make sure to check "Import Maven projects automatically" and have "Generated sources folders" set to "Detect automatically".
7171
1. Click `Next` until the project is imported (no Maven profile needs to be selected).
7272
1. In order to have both development versions of AutomataLib and LearnLib available at once, continue to import AutomataLib as documented in the project's README, but choose `File` -> `New` -> `Module from existing sources` as the first step.
7373

0 commit comments

Comments
 (0)