Merge pull request #23 from IBM/pre-release

Pre release
IBM · Jun 13, 2023 · e60ae8e · e60ae8e
2 parents 699971a + 8439f97
commit e60ae8e
Show file tree

Hide file tree

Showing 8 changed files with 51 additions and 0 deletions.
diff --git a/AUTHORS.md 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)? 
diff --git a/CHANGES.md 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
@@ -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.
diff --git 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 

diff --git a/docs/authors.md b/docs/authors.md
@@ -0,0 +1 @@
+{!../AUTHORS.md!}
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -0,0 +1 @@
+{!../CHANGES.md!}
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -0,0 +1 @@
+{!../CONTRIBUTING.md!}
diff --git a/docs/references.md 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.