Update doc/ index and Doxyfile.in

Author: pockerman

doc/Doxyfile.in

@@ -4,6 +4,9 @@ PROJECT_NAME           = "@PROJECT_NAME@"
 OUTPUT_DIRECTORY       = @PROJECT_SOURCE_DIR@/docs
 GENERATE_LATEX         = NO
 RECURSIVE              = YES
+MARKDOWN_SUPPORT = YES
+AUTOLINK_SUPPORT = YES
+EXTRACT_ALL = YES
 
 # Adjust to your source path(s)
 INPUT                  = @PROJECT_SOURCE_DIR@/src/bitrl @PROJECT_SOURCE_DIR@/doc

doc/index.md

@@ -1,113 +1,70 @@
-# bitrl
-
-```bitrl``` is an effort to provide implementations and wrappers of environments suitable for training reinforcement learning agents
+# bitrl-doc
+_bitrl_ is an effort to provide implementations and wrappers of environments suitable for training reinforcement learning agents
 using  C++.
 
-Furthermore, there is some minimal support for working with Arduino UNO boards over USB or WiFi.
-See also <a href="https://rlenvscpp.readthedocs.io/en/latest/working_with_webots.html">Working with Webots</a>
-for how to integrate ```bitrl``` with <a href="https://cyberbotics.com/doc/guide/installing-webots">Webots</a>.
-
-Various RL algorithms using the environments can be found at <a href="https://github.com/pockerman/cuberl/tree/master">cuberl</a>.
-
-The documentation for the library can be found <a href="https://rlenvscpp.readthedocs.io/en/latest/">here</a>.
 The following is an example how to use the
-``FrozenLake``   environment from <a href="https://github.com/Farama-Foundation/Gymnasium/tree/main">Gymnasium</a>.
-
-```
+_FrozenLake_   environment from <a href="https://github.com/Farama-Foundation/Gymnasium/tree/main">Gymnasium</a>.
 
+@code
 #include "bitrl/bitrl_types.h"
 #include "bitrl/envs/gymnasium/toy_text/frozen_lake_env.h"
-#include "bitrl/envs/api_server/apiserver.h"
+#include "bitrl/network/rest_rl_env_client.h"
 
 #include <iostream>
 #include <string>
 #include <unordered_map>
 #include <any>
 
-namespace example_1{
-
+namespace example_1 {
 const std::string SERVER_URL = "http://0.0.0.0:8001/api";
-
 using bitrl::envs::gymnasium::FrozenLake;
-using bitrl::envs::gymnasium::Taxi;
-using bitrl::envs::gymnasium::BlackJack;
-using bitrl::envs::gymnasium::CliffWorld;
 using bitrl::envs::RESTApiServerWrapper;
 
+void test_frozen_lake(const RESTApiServerWrapper& server) {
 
-void test_frozen_lake(const RESTApiServerWrapper& server){
-
-    FrozenLake<4> env(server);
-
-    std::cout<<"Environame URL: "<<env.get_url()<<std::endl;
-
-    // make the environment
-    std::unordered_map<std::string, std::any> options;
-    options.insert({"is_slippery", false});
-    env.make("v1", options);
-
-    std::cout<<"Is environment created? "<<env.is_created()<<std::endl;
-    std::cout<<"Is environment alive? "<<env.is_alive()<<std::endl;
-    std::cout<<"Number of valid actions? "<<env.n_actions()<<std::endl;
-    std::cout<<"Number of states? "<<env.n_states()<<std::endl;
+     FrozenLake<4> env(server);
+     std::cout << "Environment URL: " << env.get_url() << std::endl;
+     
+     std::unordered_map<std::string, std::any> make_ops;
+     make_ops.insert({"is_slippery", false});
+     
+     std::unordered_map<std::string, std::any> reset_ops;
+     reset_ops.insert({"seed", static_cast<uint_t>(42)});
 
-    // reset the environment
-    auto time_step = env.reset(42, std::unordered_map<std::string, std::any>());
-
-    std::cout<<"Reward on reset: "<<time_step.reward()<<std::endl;
-    std::cout<<"Observation on reset: "<<time_step.observation()<<std::endl;
-    std::cout<<"Is terminal state: "<<time_step.done()<<std::endl;
-
-    //...print the time_step
-    std::cout<<time_step<<std::endl;
-
-    // take an action in the environment
-	// 2 = RIGHT
-    auto new_time_step = env.step(2);
-
-    std::cout<<new_time_step<<std::endl;
+     env.make("v1", make_ops, reset_ops);
+}
+} // namespace example_1
 
-    // get the dynamics of the environment for the given state and action
-    auto state = 0;
-    auto action = 1;
-    auto dynamics = env.p(state, action);
+int main() {
+RESTApiServerWrapper server(SERVER_URL, true);
+example_1::test_frozen_lake(server);
+return 0;
+}
+@endcode
 
-    std::cout<<"Dynamics for state="<<state<<" and action="<<action<<std::endl;
 
-    for(auto item:dynamics){
+Gymnasium environments exposed over a REST like API can be found at: <a href="https://github.com/pockerman/bitrl-rest-api">bitrl-rest-api</a>.
+Various RL algorithms using the environments can be found at <a href="https://github.com/pockerman/cuberl/tree/master">cuberl</a>.
 
-        std::cout<<std::get<0>(item)<<std::endl;
-        std::cout<<std::get<1>(item)<<std::endl;
-        std::cout<<std::get<2>(item)<<std::endl;
-        std::cout<<std::get<3>(item)<<std::endl;
-    }
-	
-	action = env.sample_action();
-	std::cout<<"Action sampled: "<<action<<std::endl;
-	
-	new_time_step = env.step(action);
-    std::cout<<new_time_step<<std::endl;
-	
-	std::cout<<"env cidx: "<<env.cidx()<<std::endl;
+## Dependencies
 
-    // close the environment
-    env.close();
-}
+_bitrl_ has a number of dependencies assumed to be installed under usual destination on a system:
 
-}
+- Boost
+- Eigen3
+- Blas
+- OpenCV
+- PahoMqttCpp
 
+## Installation
 
-int main(){
+The usual _cmake_ installation/build can be used:
 
-	using namespace example_1;
-	
-	RESTApiServerWrapper server(SERVER_URL, true);
+@code
+mkdir build && cd build
+cmake -DCMAKE_INSTALL_PREFIX=/path/where/bitrl/should/be/installed/to ..
+make install -j4
+@endcode
 
-    std::cout<<"Testing FrozenLake..."<<std::endl;
-    example_1::test_frozen_lake(server);
-    std::cout<<"===================="<<std::endl;
-  
-    return 0;
-}
+## Examples
 
-```