[Docs] update and fix content hyperlinks

ai4co · Aug 24, 2024 · 51aab48 · 51aab48
1 parent d1d97eb
commit 51aab48
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 8 deletions.
diff --git a/docs/content/general/contribute.md b/docs/content/general/contribute.md
@@ -3,7 +3,7 @@
 [![Slack](https://img.shields.io/badge/slack-chat-611f69.svg?logo=slack)](https://join.slack.com/t/rl4co/shared_invite/zt-1ytz2c1v4-0IkQ8NQH4TRXIX8PrRmDhQ)
 
 Have a suggestion, request, or found a bug? Feel free to [open an issue](https://github.com/ai4co/rl4co/issues) or [submit a pull request](https://github.com/ai4co/rl4co/pulls).
-If you would like to contribute, please check out our contribution guidelines   [here](.github/CONTRIBUTING.md). We welcome and look forward to all contributions to RL4CO!
+If you would like to contribute, please check out our contribution guidelines   [here](../../../.github/CONTRIBUTING.md). We welcome and look forward to all contributions to RL4CO!
 
 We are also on [Slack](https://join.slack.com/t/rl4co/shared_invite/zt-1ytz2c1v4-0IkQ8NQH4TRXIX8PrRmDhQ) if you have any questions or would like to discuss RL4CO with us. We are open to collaborations and would love to hear from you 🚀
 

diff --git a/docs/content/general/faq.md b/docs/content/general/faq.md
@@ -2,10 +2,23 @@
 
 
 
-You can submit your questions via [GitHub Issues](https://github.com/ai4co/rl4co/discussions) or [Discussions](https://github.com/ai4co/rl4co/discussions). You may search for your question in the existing issues or discussions before submitting a new one.
+You can submit your questions via [GitHub Issues](https://github.com/ai4co/rl4co/issues) or [Discussions](https://github.com/ai4co/rl4co/discussions). 
 
+You may search for your question in the existing issues or discussions before submitting a new one. If asked more than a few times, we will add it here!
 
-If ask more than a few times, we will add it here!
 
 
+### I ran into an error in the tutorials. What should I do?
+
+We try our best to test the tutorials but some edge cases may not be covered. If you encounter an issue, firstly we recommend to try installing the bleeding edge version of the library from source, which may resolve the it. You can do this by running the following command:
+
+```bash
+pip install -U git+https://github.com/ai4co/rl4co.git
+```
+
+If you still encounter an error, you may check out open issues on GitHub [here](https://github.com/ai4co/rl4co/issues) and in case open one. Remember to report versions of the library and the environment you are using with the following commands:
+
+```bash
+python -c 'from rl4co.utils import show_versions; show_versions()'
+```
 
diff --git a/docs/content/start/hydra.md b/docs/content/start/hydra.md
@@ -1,6 +1,6 @@
 # Training with Hydra Configuration
 
-You may find Hydra configurations under [configs/](configs/) divided into categories (model, env, train, experiment, etc.).
+You may find Hydra configurations under [configs/](../../../configs/) divided into categories (model, env, train, experiment, etc.).
 
 ## Usage
 
@@ -10,16 +10,16 @@ python run.py
 ```
 
 !!! tip
-    You may check out [this notebook](examples/advanced/1-hydra-config.ipynb) to get started with Hydra!
+    You may check out [this notebook](../../../examples/advanced/1-hydra-config.ipynb) to get started with Hydra!
 
 
 ### Change experiment
 
-Train model with chosen experiment configuration from [configs/experiment/](configs/experiment/)
+Train model with chosen experiment configuration from [configs/experiment/](../../../configs/experiment/)
 ```bash
 python run.py experiment=routing/am env=tsp env.generator_params.num_loc=50 model.optimizer_kwargs.lr=2e-4
 ```
-Here you may change the environment, e.g. with `env=cvrp` by command line or by modifying the corresponding experiment e.g. [configs/experiment/routing/am.yaml](configs/experiment/routing/am.yaml).
+Here you may change the environment, e.g. with `env=cvrp` by command line or by modifying the corresponding experiment e.g. [configs/experiment/routing/am.yaml](../../../configs/experiment/routing/am.yaml).
 </details>
 
 

diff --git a/examples/README.md b/examples/README.md
@@ -25,3 +25,6 @@ Under the [`datasets/`](datasets) directory, here are some additional examples f
 
 ### Advanced
 Under the [`advanced/`](advanced) directory, here are some additional examples for advanced topics.
+
+### Other
+Under the [`other/`](other) directory, here are some additional examples for other topics.
diff --git a/examples/modeling/README.md b/examples/modeling/README.md
@@ -6,5 +6,5 @@ Collection of examples on models and related topics.
 ## Index
 
 - [`1-decoding-strategies.ipynb`](1-decoding-strategies.ipynb): here we show how to use different decoding strategies at inference time, such as greedy evaluation, beam search, and various sampling methods including top-k and nucleus sampling.
-- [`2-search-methods.ipynb`](2-search-methods.ipynb): here we show how to use search methods such as EAS for test-time optimization.
+- [`2-transductive-methods.ipynb`](2-transductive-methods.ipynb): here we show how to use transductive methods (i.e. online / test time optimization) such as EAS.
 - [`3-change-encoder.ipynb`](3-change-encoder.ipynb): here we show how to change the encoder of a model.
diff --git a/examples/other/README.md b/examples/other/README.md
@@ -0,0 +1,9 @@
+# Miscellaneous Examples
+
+Collection of examples on other topics.
+
+## Index
+
+- [`1-mtvrp.ipynb`](1-mtvrp.ipynb): here we show how to use the Multi-Task Vehicle Routing Problem (MTVRP) environment, which includes 16 tasks that can be solved simultaneously.
+- [`2-scheduling.ipynb`](2-scheduling.ipynb): provides a brief introduction to scheduling problems with RL4CO with the Flexible Job Shop Scheduling Problem (FJSP) environment.
+- [`3-data-generator-distributions.ipynb`](3-data-generator-distributions.ipynb): here we show how to use the data generators and how to generate data from custom distributions.