deprecated in favor of POMDPTools

JuliaPOMDP · Jul 22, 2022 · 3949a0b · 3949a0b
1 parent 43f015d
commit 3949a0b
Show file tree

Hide file tree

Showing 26 changed files with 23 additions and 1,722 deletions.
diff --git a/Project.toml b/Project.toml
@@ -8,8 +8,10 @@ CommonRLInterface = "d842c3ba-07a1-494f-bbec-f5741b0a3e98"
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 POMDPLinter = "f3bd98c0-eb40-45e2-9eb1-f2763262d755"
+POMDPTools = "7588e00f-9cae-40de-98dc-e0c70c48cdd7"
 POMDPs = "a93abf59-7444-517b-a68a-c42f96afdd7d"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
+Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 Tricks = "410a4b4d-49e4-4fbc-ab6d-cb71b17b3775"

diff --git a/README.md b/README.md
@@ -1,16 +1,3 @@
-# POMDPModelTools
+# ~~POMDPModelTools~~
 
-[![Build Status](https://travis-ci.org/JuliaPOMDP/POMDPModelTools.jl.svg?branch=master)](https://travis-ci.org/JuliaPOMDP/POMDPModelTools.jl)
-[![Coverage Status](https://coveralls.io/repos/github/JuliaPOMDP/POMDPModelTools.jl/badge.svg?branch=master)](https://coveralls.io/github/JuliaPOMDP/POMDPModelTools.jl?branch=master)
-[![Stable Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaPOMDP.github.io/POMDPModelTools.jl/stable)
-[![Dev Docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaPOMDP.github.io/POMDPModelTools.jl/dev)
-
-Support tools for writing and working with [POMDPs.jl](github.com/JuliaPOMDP/POMDPs.jl) models and solvers.
-
-Please read the documentation for a list of tools: [https://JuliaPOMDP.github.io/POMDPModelTools.jl/stable](https://JuliaPOMDP.github.io/POMDPModelTools.jl/stable). If that link does not work, look at the development branch: [https://JuliaPOMDP.github.io/POMDPModelTools.jl/dev](https://JuliaPOMDP.github.io/POMDPModelTools.jl/dev)
-
-## Installation
-
-```julia-repl
-julia> using Pkg; Pkg.add("POMDPModelTools")
-```
+POMDPModelTools is deprecated! Use [POMDPTools](https://github.com/JuliaPOMDP/POMDPs.jl/tree/master/lib/POMDPTools) instead.
diff --git a/src/POMDPModelTools.jl b/src/POMDPModelTools.jl
@@ -1,133 +1,28 @@
 module POMDPModelTools
 
-using POMDPs
-using Random
-using LinearAlgebra
-using SparseArrays
-using UnicodePlots
-import CommonRLInterface
-using Tricks: static_hasmethod
+Base.depwarn("""
+             Functionality from POMDPModelTools has been moved to POMDPTools.
 
-import POMDPs: actions, actionindex
-import POMDPs: states, stateindex
-import POMDPs: observations, obsindex
-import POMDPs: initialstate, isterminal, discount
-import POMDPs: implemented
-import Distributions: pdf, mode, mean, support
-import Random: rand, rand!
-import Statistics: mean
-import Base: ==
+             Simply replace `using POMDPModelTools` with `using POMDPTools`.
+             """, :POMDPModelTools)
 
-import POMDPLinter: @POMDP_require
+using Reexport
+using Random: AbstractRNG
+import POMDPs
 
-export
-    render
-include("visualization.jl")
-
-# info interface
-export
-    action_info,
-    solve_info,
-    update_info
-include("info.jl")
-
-export
-    ordered_states,
-    ordered_actions,
-    ordered_observations
-include("ordered_spaces.jl")
-
-export
-    TerminalState,
-    terminalstate
-include("terminal_state.jl")
-
-export GenerativeBeliefMDP
-include("generative_belief_mdp.jl")
-
-export FullyObservablePOMDP
-include("fully_observable_pomdp.jl")
-
-export UnderlyingMDP
-include("underlying_mdp.jl")
-
-export obs_weight
-include("obs_weight.jl")
-
-export
-    probability_check,
-    obs_prob_consistency_check,
-    trans_prob_consistency_check
-
-export
-    weighted_iterator
-include("distributions/weighted_iteration.jl")
-
-export
-    SparseCat
-include("distributions/sparse_cat.jl")
-
-export
-    BoolDistribution
-include("distributions/bool.jl")
+import POMDPTools
 
-export
-    Deterministic
-include("distributions/deterministic.jl")
+@reexport using POMDPTools.ModelTools
+@reexport using POMDPTools.POMDPDistributions
+@reexport using POMDPTools.Policies: evaluate
+@reexport using POMDPTools.CommonRLIntegration
 
-export
-    Uniform,
-    UnsafeUniform
-include("distributions/uniform.jl")
-
-export
-    ImplicitDistribution
-include("distributions/implicit.jl")
-
-export
-    StateActionReward,
-    FunctionSAR,
-    LazyCachedSAR
-include("state_action_reward.jl")
+policy_reward_vector = POMDPTools.Policies.policy_reward_vector
+mean_reward = POMDPTools.ModelTools.mean_reward
 
 # convenient implementations
 include("convenient_implementations.jl")
 
-export
-    evaluate
-include("policy_evaluation.jl")
-
-export
-    showdistribution
-include("distributions/pretty_printing.jl")
-
-export 
-    SparseTabularMDP,
-    SparseTabularPOMDP,
-    transition_matrix,
-    reward_vector,
-    observation_matrix,
-    reward_matrix,
-    observation_matrices
-include("sparse_tabular.jl")
-
-export
-    transition_matrices,
-    reward_vectors
-include("matrices.jl")
-
-export
-    MDPCommonRLEnv,
-    POMDPCommonRLEnv
-include("common_rl/to_env.jl") 
-
-export
-    RLEnvMDP,
-    RLEnvPOMDP,
-    OpaqueRLEnvMDP,
-    OpaqueRLEnvPOMDP
-include("common_rl/from_env.jl") 
-
 export
     add_infonode
 include("deprecated.jl")