pyRDDLGym-jax 0.1__tar.gz → 0.3__tar.gz

{pyRDDLGym-jax-0.1 → pyrddlgym_jax-0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyRDDLGym-jax
-Version: 0.1
+Version: 0.3
 Summary: pyRDDLGym-jax: JAX compilation of RDDL description files, and a differentiable planner in JAX.
 Home-page: https://github.com/pyrddlgym-project/pyRDDLGym-jax
 Author: Michael Gimelfarb, Ayal Taitler, Scott Sanner

{pyRDDLGym-jax-0.1 → pyrddlgym_jax-0.3}/README.md

@@ -33,24 +33,12 @@ To use the compiler or planner without the automated hyper-parameter tuning, you
 
 Additionally, if you wish to run the examples, you need ``rddlrepository>=2``, and run the automated tuning optimization, you will also need ``bayesian-optimization>=1.4.3``.
 
-You can install this package, together with all of its requirements as follows (assuming Anaconda):
+You can install this package, together with all of its requirements via pip:
 
 ```shell
-# Create a new conda environment
-conda create -n jaxplan python=3.11
-conda activate jaxplan
-conda install pip git
-
-# Manually install pyRDDLGym and rddlrepository
-pip install git+https://github.com/pyrddlgym-project/pyRDDLGym
-pip install git+https://github.com/pyrddlgym-project/rddlrepository
-
-# Install pyRDDLGym-jax
-pip install git+https://github.com/pyrddlgym-project/pyRDDLGym-jax
+pip install rddlrepository pyRDDLGym-jax
 ```
 
-A pip installer will be coming soon.
-
 ## Running the Basic Examples
 
 A basic run script is provided to run the Jax Planner on any domain in ``rddlrepository``, provided a config file is available (currently, only a limited subset of configs are provided as examples).
@@ -232,19 +220,33 @@ An [example is provided to illustrate how you can define your own policy class a
 
 ## Citing pyRDDLGym-jax
 
-The main ideas of this approach are discussed in the following preprint:
+The [following citation](https://ojs.aaai.org/index.php/ICAPS/article/view/31480) describes the main ideas of the framework. Please cite it if you found it useful:
+
+```
+@inproceedings{gimelfarb2024jaxplan,
+    title={JaxPlan and GurobiPlan: Optimization Baselines for Replanning in Discrete and Mixed Discrete and Continuous Probabilistic Domains},
+    author={Michael Gimelfarb and Ayal Taitler and Scott Sanner},
+    booktitle={34th International Conference on Automated Planning and Scheduling},
+    year={2024},
+    url={https://openreview.net/forum?id=7IKtmUpLEH}
+}
+```
+
+The utility optimization is discussed in [this paper](https://ojs.aaai.org/index.php/AAAI/article/view/21226):
 
 ```
-@article{taitler2022pyrddlgym,
-      title={pyRDDLGym: From RDDL to Gym Environments},
-      author={Taitler, Ayal and Gimelfarb, Michael and Gopalakrishnan, Sriram and Mladenov, Martin and Liu, Xiaotian and Sanner, Scott},
-      journal={arXiv preprint arXiv:2211.05939},
-      year={2022}
+@inproceedings{patton2022distributional,
+    title={A distributional framework for risk-sensitive end-to-end planning in continuous mdps},
+    author={Patton, Noah and Jeong, Jihwan and Gimelfarb, Mike and Sanner, Scott},
+    booktitle={Proceedings of the AAAI Conference on Artificial Intelligence},
+    volume={36},
+    number={9},
+    pages={9894--9901},
+    year={2022}
 }
 ```
 
-Many of the implementation details discussed come from the following literature, which you may wish to cite in your research papers:
-- [A Distributional Framework for Risk-Sensitive End-to-End Planning in Continuous MDP, AAAI 2022](https://ojs.aaai.org/index.php/AAAI/article/view/21226)
+Some of the implementation details derive from the following literature, which you may wish to also cite in your research papers:
 - [Deep reactive policies for planning in stochastic nonlinear domains, AAAI 2019](https://ojs.aaai.org/index.php/AAAI/article/view/4744)
 - [Scalable planning with tensorflow for hybrid nonlinear domains, NeurIPS 2017](https://proceedings.neurips.cc/paper/2017/file/98b17f068d5d9b7668e19fb8ae470841-Paper.pdf)
 

pyrddlgym_jax-0.3/pyRDDLGym_jax/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.3'