From 01e515d802ccd9c91c6108f2a05e129af5932b8b Mon Sep 17 00:00:00 2001 From: Francesco Fuggitti Date: Tue, 13 Jun 2023 15:58:35 -0400 Subject: [PATCH 1/3] add docs Signed-off-by: Francesco Fuggitti --- AUTHORS.md | 10 ++++++++++ CHANGES.md | 18 ++++++++++++++++++ CONTRIBUTING.md | 9 +++++++++ docs/changelog.md | 1 + docs/contributing.md | 1 + docs/references.md | 7 +++++++ 6 files changed, 46 insertions(+) create mode 100644 AUTHORS.md create mode 100644 CHANGES.md create mode 100644 CONTRIBUTING.md create mode 100644 docs/changelog.md create mode 100644 docs/contributing.md create mode 100644 docs/references.md diff --git a/AUTHORS.md b/AUTHORS.md new file mode 100644 index 0000000..dc44704 --- /dev/null +++ b/AUTHORS.md @@ -0,0 +1,10 @@ +# Credits + +## Maintainers + +* [Francesco Fuggitti](https://github.com/francescofuggitti) <[francesco.fuggitti@gmail.com](mailto:francesco.fuggitti@gmail.com)> +* [Tathagata Chakraborti](http://tchakra2.com) <[tathagata.chakraborti1@ibm.com](mailto:tathagata.chakraborti1@ibm.com)> + +## Contributors + +None yet. [Why not be the first](./contributing.md)? \ No newline at end of file diff --git a/CHANGES.md b/CHANGES.md new file mode 100644 index 0000000..7dc52e6 --- /dev/null +++ b/CHANGES.md @@ -0,0 +1,18 @@ +# Change Log + +## 0.0.3 (2023-06-13) + +Main changes: + +* Bump RASA version to 3.5.11. +* Bump PyLogics version to 0.2.1. +* Bump OpenAI version to 0.27.8. +* Support for GPT-x models and different modes of operations. + +## 0.0.2 (2022-09-22) + +* Minor fixes. + +## 0.0.1 (2022-09-22) + +* First release of the package. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f6b193a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,9 @@ +# Contributing + +Contributions are welcome, and greatly appreciated! Every little bit helps, and credit will always be given. + +If you need support, want to report/fix a bug, ask for/implement features, you can check the +[Issues page](https://github.com/IBM/nl2ltl/issues) +or [submit a Pull request](https://github.com/IBM/nl2ltl/pulls). + +For other kinds of feedback, you can contact one of the [authors](./authors.md) by email. \ No newline at end of file diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 0000000..8de33c9 --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1 @@ +{!../CHANGES.md!} \ No newline at end of file diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 0000000..568877b --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1 @@ +{!../CONTRIBUTING.md!} diff --git a/docs/references.md b/docs/references.md new file mode 100644 index 0000000..693d84f --- /dev/null +++ b/docs/references.md @@ -0,0 +1,7 @@ +# References + +1. Fuggitti, F.; and Chakraborti, T. "NL2LTL – A Python Package for Converting Natural Language (NL) Instructions to Linear Temporal Logic (LTL) Formulas". In ICAPS, System Demonstration, 2023. +2. Fuggitti, F.; and Chakraborti, T.. "NL2LTL – A Python Package for Converting Natural Language (NL) Instructions to Linear Temporal Logic (LTL) Formulas". In AAAI, System Demonstration, 2022. +3. Bonassi, L.; De Giacomo, G.; Favorito, M.; Fuggitti, F.; Gerevini, A.; and Scala, E.. "Planning for Temporally Extended Goals in Pure-Past Linear Temporal Logic". In ICAPS, 2023. +4. De Giacomo, G.; Di Stasio, A.; Fuggitti, F.; Rubin, S.. Pure-Past Linear Temporal and Dynamic Logic on Finite Traces. In IJCAI, 2020. +5. De Giacomo, G.; and Vardi, M.. Linear temporal logic and linear dynamic logic on finite traces. In IJCAI, 2013. From d37c0b9100e3837be71d38a0f5f534a8bbf0beb3 Mon Sep 17 00:00:00 2001 From: Francesco Fuggitti Date: Tue, 13 Jun 2023 16:01:40 -0400 Subject: [PATCH 2/3] update readme Signed-off-by: Francesco Fuggitti --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index c1de86d..65c70ae 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,10 @@ NL2LTL is an interface to translate natural language (NL) utterances to linear temporal logic (LTL) formulas. ## Installation +- from PyPI: +```bash +pip install nl2ltl +``` - from source (`main` branch): ```bash pip install git+https://github.com/IBM/nl2ltl.git From 8439f9703dcbeff3aa25e1fab54bfd666ca77e9e Mon Sep 17 00:00:00 2001 From: Francesco Fuggitti Date: Tue, 13 Jun 2023 16:08:49 -0400 Subject: [PATCH 3/3] add authors docs page Signed-off-by: Francesco Fuggitti --- docs/authors.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 docs/authors.md diff --git a/docs/authors.md b/docs/authors.md new file mode 100644 index 0000000..02e330e --- /dev/null +++ b/docs/authors.md @@ -0,0 +1 @@ +{!../AUTHORS.md!}