Skip to content

Commit

Permalink
docs: change link to OmniSafeAI (#205)
Browse files Browse the repository at this point in the history
  • Loading branch information
zmsn-2077 authored Apr 6, 2023
1 parent 52aaf32 commit ace1fe8
Show file tree
Hide file tree
Showing 16 changed files with 197 additions and 135 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ body:
- type: markdown
attributes:
value: |
Please do your best to make the issue as easy to act on as possible, and only submit here if there is clearly a problem with OmniSafe (ask in [Discussions](https://github.com/PKU-MARL/omnisafe/discussions) first if unsure).
Please do your best to make the issue as easy to act on as possible, and only submit here if there is clearly a problem with OmniSafe (ask in [Discussions](https://github.com/OmniSafeAI/omnisafe/discussions) first if unsure).
- type: checkboxes
id: steps
Expand All @@ -17,9 +17,9 @@ body:
options:
- label: I have read the documentation <https://omnisafe.readthedocs.io>.
required: true
- label: I have searched the [Issue Tracker](https://github.com/PKU-MARL/omnisafe/issues) and [Discussions](https://github.com/PKU-MARL/omnisafe/discussions) that this hasn't already been reported. (+1 or comment there if it has.)
- label: I have searched the [Issue Tracker](https://github.com/OmniSafeAI/omnisafe/issues) and [Discussions](https://github.com/OmniSafeAI/omnisafe/discussions) that this hasn't already been reported. (+1 or comment there if it has.)
required: true
- label: Consider asking first in a [Discussion](https://github.com/PKU-MARL/omnisafe/discussions/new).
- label: Consider asking first in a [Discussion](https://github.com/OmniSafeAI/omnisafe/discussions/new).
required: false

- type: input
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: 💬 Start a discussion
url: https://github.com/PKU-MARL/omnisafe/discussions/new
url: https://github.com/OmniSafeAI/omnisafe/discussions/new
about: Please ask and answer questions here if unsure.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ body:
label: Required prerequisites
description: Make sure you've completed the following steps before submitting your issue -- thank you!
options:
- label: I have searched the [Issue Tracker](https://github.com/PKU-MARL/omnisafe/issues) and [Discussions](https://github.com/PKU-MARL/omnisafe/discussions) that this hasn't already been reported. (+1 or comment there if it has.)
- label: I have searched the [Issue Tracker](https://github.com/OmniSafeAI/omnisafe/issues) and [Discussions](https://github.com/OmniSafeAI/omnisafe/discussions) that this hasn't already been reported. (+1 or comment there if it has.)
required: true
- label: Consider asking first in a [Discussion](https://github.com/PKU-MARL/omnisafe/discussions/new).
- label: Consider asking first in a [Discussion](https://github.com/OmniSafeAI/omnisafe/discussions/new).
required: false

- type: textarea
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/questions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ body:
options:
- label: I have read the documentation <https://omnisafe.readthedocs.io>.
required: true
- label: I have searched the [Issue Tracker](https://github.com/PKU-MARL/omnisafe/issues) and [Discussions](https://github.com/PKU-MARL/omnisafe/discussions) that this hasn't already been reported. (+1 or comment there if it has.)
- label: I have searched the [Issue Tracker](https://github.com/OmniSafeAI/omnisafe/issues) and [Discussions](https://github.com/OmniSafeAI/omnisafe/discussions) that this hasn't already been reported. (+1 or comment there if it has.)
required: true
- label: Consider asking first in a [Discussion](https://github.com/PKU-MARL/omnisafe/discussions/new).
- label: Consider asking first in a [Discussion](https://github.com/OmniSafeAI/omnisafe/discussions/new).
required: false

- type: textarea
Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Why is this change required? What problem does it solve?
If it fixes an open issue, please link to the issue here.
You can use the syntax `close #15213` if this solves the issue #15213

- [ ] I have raised an issue to propose this change ([required](https://github.com/PKU-MARL/omnisafe/issues) for new features and bug fixes)
- [ ] I have raised an issue to propose this change ([required](https://github.com/OmniSafeAI/omnisafe/issues) for new features and bug fixes)

## Types of changes

Expand Down
236 changes: 150 additions & 86 deletions CHANGELOG.md

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ into two categories:
- Create an issue about your intended feature, and we shall discuss the design and
implementation. Once we agree that the plan looks good, go ahead and implement it.
2. You want to implement a feature or bug-fix for an outstanding issue
- Look at the outstanding issues here: https://github.com/PKU-MARL/omnisafe/issues
- Look at the outstanding issues here: https://github.com/OmniSafeAI/omnisafe/issues
- Pick an issue or feature and comment on the task that you want to work on this feature.
- If you need more context on a particular issue, please ask and we shall provide.

Once you finish implementing a feature or bug-fix, please send a Pull Request to https://github.com/PKU-MARL/omnisafe
Once you finish implementing a feature or bug-fix, please send a Pull Request to https://github.com/OmniSafeAI/omnisafe

If you are not familiar with creating a Pull Request, here are some guides:

Expand All @@ -25,7 +25,7 @@ To develop OmniSafe on your machine, here are some tips:
1. Clone a copy of OmniSafe from GitHub:

```bash
git clone https://github.com/PKU-MARL/omnisafe
git clone https://github.com/OmniSafeAI/omnisafe
cd omnisafe/
```

Expand Down
36 changes: 17 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,30 @@
<!-- markdownlint-disable html -->

<div align="center">
<img src="https://github.com/PKU-MARL/omnisafe/raw/HEAD/images/logo.png" width="75%"/>
<img src="https://github.com/OmniSafeAI/omnisafe/raw/HEAD/images/logo.png" width="75%"/>
</div>

<div align="center">

[![Organization](https://img.shields.io/badge/Organization-PKU_MARL-blue.svg)](https://github.com/PKU-MARL)
[![Organization](https://img.shields.io/badge/Organization-PKU_MARL-blue.svg)](https://github.com/OmniSafeAI)
[![PyPI](https://img.shields.io/pypi/v/omnisafe?logo=pypi)](https://pypi.org/project/omnisafe)
[![tests](https://img.shields.io/github/actions/workflow/status/PKU-MARL/omnisafe/test.yml?label=tests&logo=github)](https://github.com/OmniSafeAI/omnisafe/tree/HEAD/tests)
[![tests](https://img.shields.io/github/actions/workflow/status/OmniSafeAI/omnisafe/test.yml?label=tests&logo=github)](https://github.com/OmniSafeAI/omnisafe/tree/HEAD/tests)
[![Documentation Status](https://img.shields.io/readthedocs/omnisafe?logo=readthedocs)](https://omnisafe.readthedocs.io)
[![Downloads](https://static.pepy.tech/personalized-badge/omnisafe?period=total&left_color=grey&right_color=blue&left_text=downloads)](https://pepy.tech/project/omnisafe)
[![GitHub Repo Stars](https://img.shields.io/github/stars/PKU-MARL/omnisafe?color=brightgreen&logo=github)](https://github.com/PKU-MARL/OmniSafe/stargazers)
[![GitHub Repo Stars](https://img.shields.io/github/stars/OmniSafeAI/omnisafe?color=brightgreen&logo=github)](https://github.com/OmniSafeAI/OmniSafe/stargazers)
[![codestyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![License](https://img.shields.io/github/license/PKU-MARL/OmniSafe?label=license)](#license)
[![CodeCov](https://img.shields.io/codecov/c/github/PKU-MARL/omnisafe/main?logo=codecov)](https://app.codecov.io/gh/PKU-MARL/omnisafe)
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/PKU-MARL/omnisafe/)
[![License](https://img.shields.io/github/license/OmniSafeAI/OmniSafe?label=license)](#license)
[![CodeCov](https://img.shields.io/codecov/c/github/OmniSafeAI/omnisafe/main?logo=codecov)](https://app.codecov.io/gh/OmniSafeAI/omnisafe)
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/OmniSafeAI/omnisafe/)

</div>

<p align="center">
<a href="https://omnisafe.readthedocs.io">Documentation</a> |
<a href="https://github.com/PKU-MARL/omnisafe#implemented-algorithms">Implemented Algorithms</a> |
<a href="https://github.com/PKU-MARL/omnisafe#installation">Installation</a> |
<a href="https://github.com/PKU-MARL/omnisafe#getting-started">Getting Started</a> |
<a href="https://github.com/PKU-MARL/omnisafe#license">License</a>
<a href="https://github.com/OmniSafeAI/omnisafe#implemented-algorithms">Implemented Algorithms</a> |
<a href="https://github.com/OmniSafeAI/omnisafe#installation">Installation</a> |
<a href="https://github.com/OmniSafeAI/omnisafe#getting-started">Getting Started</a> |
<a href="https://github.com/OmniSafeAI/omnisafe#license">License</a>
</p>

--------------------------------------------------------------------------------
Expand Down Expand Up @@ -140,7 +140,7 @@ OmniSafe requires Python 3.8+ and PyTorch 1.10+.

```bash
# Clone the repo
git clone https://github.com/PKU-MARL/omnisafe
git clone https://github.com/OmniSafeAI/omnisafe
cd omnisafe

# Create a conda environment
Expand Down Expand Up @@ -226,7 +226,7 @@ More information about environments, please refer to [Safety Gymnasium](https://

**A video example**

![Segmentfault](https://github.com/PKU-MARL/omnisafe/blob/main/images/CLI_example.svg)
![Segmentfault](https://github.com/OmniSafeAI/omnisafe/blob/main/images/CLI_example.svg)

```bash
pip install omnisafe
Expand Down Expand Up @@ -258,21 +258,19 @@ omnisafe train-config ./saved_source/train_config.yaml

### Quickstart: Colab in the Cloud
Explore OmniSafe easily and quickly through a series of colab notebooks:
- [Getting Started](https://colab.research.google.com/github/PKU-MARL/omnisafe/blob/main/tutorials/English/1.Getting_Started.ipynb) Introduce the basic usage of OmniSafe so that users can quickly hand on it.
- [CLI Command](https://colab.research.google.com/github/PKU-MARL/omnisafe/blob/main/tutorials/English/2.CLI_Command.ipynb) Introduce how to use the CLI tool of OmniSafe.
- [Getting Started](https://colab.research.google.com/github/OmniSafeAI/omnisafe/blob/main/tutorials/English/1.Getting_Started.ipynb) Introduce the basic usage of OmniSafe so that users can quickly hand on it.
- [CLI Command](https://colab.research.google.com/github/OmniSafeAI/omnisafe/blob/main/tutorials/English/2.CLI_Command.ipynb) Introduce how to use the CLI tool of OmniSafe.

We take great pleasure in collaborating with our users to create tutorials in various languages. Please refer to our list of currently supported languages. If you are interested in translating the tutorial into a new language or improving an existing version, kindly submit a PR to us."



--------------------------------------------------------------------------------

## Changelog
See [CHANGELOG.md](https://github.com/PKU-MARL/omnisafe/blob/main/CHANGELOG.md).
See [CHANGELOG.md](https://github.com/OmniSafeAI/omnisafe/blob/main/CHANGELOG.md).

## The OmniSafe Team

OmniSafe is mainly developed by the SafeRL research team directed by Prof. [Yaodong Yang](https://github.com/orgs/PKU-MARL/people/PKU-YYang). Our SafeRL research team members include [Borong Zhang](https://github.com/muchvo), [Jiayi Zhou](https://github.com/Gaiejj), [JTao Dai](https://github.com/calico-1226), [Weidong Huang](https://github.com/hdadong), [Ruiyang Sun](https://github.com/rockmagma02), [Xuehai Pan](https://github.com/XuehaiPan) and [Jiaming Ji](https://github.com/zmsn-2077). If you have any questions in the process of using omnisafe, don't hesitate to ask your questions on [the GitHub issue page](https://github.com/PKU-MARL/omnisafe/issues/new/choose), we will reply to you in 2-3 working days.
OmniSafe is mainly developed by the SafeRL research team directed by Prof. [Yaodong Yang](https://github.com/orgs/OmniSafeAI/people/PKU-YYang). Our SafeRL research team members include [Borong Zhang](https://github.com/muchvo), [Jiayi Zhou](https://github.com/Gaiejj), [JTao Dai](https://github.com/calico-1226), [Weidong Huang](https://github.com/hdadong), [Ruiyang Sun](https://github.com/rockmagma02), [Xuehai Pan](https://github.com/XuehaiPan) and [Jiaming Ji](https://github.com/zmsn-2077). If you have any questions in the process of using omnisafe, don't hesitate to ask your questions on [the GitHub issue page](https://github.com/OmniSafeAI/omnisafe/issues/new/choose), we will reply to you in 2-3 working days.

## License

Expand Down
4 changes: 2 additions & 2 deletions benchmarks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ The OmniSafe Mujoco Velocity Benchmark assesses the efficacy of OmniSafe's SafeR
- **[ICML 2017]** [Proximal Constrained Policy Optimization (PCPO)](https://proceedings.mlr.press/v70/achiam17a)
- **[ICLR 2019]** [Reward Constrained Policy Optimization (RCPO)](https://openreview.net/forum?id=SkfrvsA9FX)

> **More details can be refer to [On Policy Experiment](https://github.com/PKU-MARL/omnisafe/tree/main/benchmarks/on-policy/README.md).**
> **More details can be refer to [On Policy Experiment](https://github.com/OmniSafeAI/omnisafe/tree/main/benchmarks/on-policy/README.md).**
## Off-Policy
### Supported Algorithms
- [Deep Deterministic Policy Gradient (DDPG)](https://arxiv.org/pdf/1509.02971.pdf)
- [Twin Delayed DDPG (TD3)](https://arxiv.org/pdf/1802.09477.pdf)
- [Soft Actor-Critic (SAC)](https://arxiv.org/pdf/1812.05905.pdf)

> **More details can be refer to [Off Policy Experiment](https://github.com/PKU-MARL/omnisafe/tree/main/benchmarks/off-policy/README.md).**
> **More details can be refer to [Off Policy Experiment](https://github.com/OmniSafeAI/omnisafe/tree/main/benchmarks/off-policy/README.md).**
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
html_context = {
'conf_py_path': '/docs/',
'display_github': False,
'github_user': 'PKU-MARL',
'github_user': 'OmniSafeAI',
'github_repo': 'OmniSafe',
'github_version': 'main',
'slug': 'omnisafe',
Expand Down
4 changes: 2 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -292,10 +292,10 @@ You may not yet understand the above theory and the specific meaning of the code
Long-Term Support and Support History
-------------------------------------

**OmniSafe** is mainly developed by the SafeRL research team directed by `Prof. Yaodong Yang <https://github.com/orgs/PKU-MARL/people/PKU-YYang>`_,
**OmniSafe** is mainly developed by the SafeRL research team directed by `Prof. Yaodong Yang <https://github.com/orgs/OmniSafeAI/people/PKU-YYang>`_,
Our SafeRL research team members include `Borong Zhang <https://github.com/muchvo>`_ , `Jiayi Zhou <https://github.com/Gaiejj>`_, `JTao Dai <https://github.com/calico-1226>`_, `Weidong Huang <https://github.com/hdadong>`_, `Ruiyang Sun <https://github.com/rockmagma02>`_, `Xuehai Pan <https://github.com/XuehaiPan>`_ and `Jiamg Ji <https://github.com/zmsn-2077>`_.
If you have any questions in the process of using OmniSafe, or if you are willing to contribute to
this project, don't hesitate to ask your question on `the GitHub issue page <https://github.com/PKU-MARL/omnisafe/issues/new/choose>`_, we will reply to you in 2-3 working days.
this project, don't hesitate to ask your question on `the GitHub issue page <https://github.com/OmniSafeAI/omnisafe/issues/new/choose>`_, we will reply to you in 2-3 working days.

------

Expand Down
2 changes: 1 addition & 1 deletion docs/source/start/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You can also install OmniSafe from source:

.. code-block:: bash
$ git clone https://github.com/PKU-MARL/omnisafe.git
$ git clone https://github.com/OmniSafeAI/omnisafe.git
$ cd omnisafe
$ conda create -n omnisafe python=3.8
$ conda activate omnisafe
Expand Down
6 changes: 3 additions & 3 deletions docs/source/start/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Customize Configuration
<script async id="asciicast-qCptIXhxYB2MWEytijrriVhUm" src="https://asciinema.org/a/qCptIXhxYB2MWEytijrriVhUm.js"></script>

.. hint::
The above command will use a configuration file `train_config.yaml <https://github.com/PKU-MARL/omnisafe/blob/main/tests/saved_source/train_config.yaml>`_ in the `saved_source <https://github.com/PKU-MARL/omnisafe/tree/main/tests/saved_source>`_ directory to train policy. We have provided an example showing the file layer of the configuration file. You can customize the configuration of the algorithm in this file.
The above command will use a configuration file `train_config.yaml <https://github.com/OmniSafeAI/omnisafe/blob/main/tests/saved_source/train_config.yaml>`_ in the `saved_source <https://github.com/OmniSafeAI/omnisafe/tree/main/tests/saved_source>`_ directory to train policy. We have provided an example showing the file layer of the configuration file. You can customize the configuration of the algorithm in this file.

Run Benchmark
-------------
Expand All @@ -93,7 +93,7 @@ Run Benchmark
<script async id="asciicast-gg6edB7OWiFENACpQzpfgFRx6" src="https://asciinema.org/a/gg6edB7OWiFENACpQzpfgFRx6.js"></script>

.. hint::
The above command will run a benchmark with 2 CPU threads. The configuration file `benchmark_config.yaml <https://github.com/PKU-MARL/omnisafe/blob/main/tests/saved_source/benchmark_config.yaml>`_ is in the `saved_source <https://github.com/PKU-MARL/omnisafe/tree/main/tests/saved_source>`_ directory. We have provided an example showing the file layer of the configuration file. You can customize the configuration of the benchmark in this file.
The above command will run a benchmark with 2 CPU threads. The configuration file `benchmark_config.yaml <https://github.com/OmniSafeAI/omnisafe/blob/main/tests/saved_source/benchmark_config.yaml>`_ is in the `saved_source <https://github.com/OmniSafeAI/omnisafe/tree/main/tests/saved_source>`_ directory. We have provided an example showing the file layer of the configuration file. You can customize the configuration of the benchmark in this file.

Run Evaluation
--------------
Expand All @@ -117,7 +117,7 @@ Run Evaluation
<script async id="asciicast-UbRWY6EI6Nl7R27Lk3Rpk4HI5" src="https://asciinema.org/a/UbRWY6EI6Nl7R27Lk3Rpk4HI5.js"></script>

.. hint::
The above command will run an evaluation with 2 CPU threads. The model parameters is in the `saved_source <https://github.com/PKU-MARL/omnisafe/tree/main/tests/saved_source>`_ directory.
The above command will run an evaluation with 2 CPU threads. The model parameters is in the `saved_source <https://github.com/OmniSafeAI/omnisafe/tree/main/tests/saved_source>`_ directory.

Get Help
--------
Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ dependencies = [
dynamic = ["version", "entry-points"]

[project.urls]
Homepage = "https://github.com/PKU-MARL/omnisafe"
Repository = "https://github.com/PKU-MARL/omnisafe"
Homepage = "https://github.com/OmniSafeAI/omnisafe"
Repository = "https://github.com/OmniSafeAI/omnisafe"
Documentation = "https://omnisafe.readthedocs.io"
"Bug Report" = "https://github.com/PKU-MARL/omnisafe/issues"
"Bug Report" = "https://github.com/OmniSafeAI/omnisafe/issues"

[project.optional-dependencies]
lint = [
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
author='OmniSafe Team',
author_email='[email protected]',
description='OmniSafe is an infrastructural framework for accelerating SafeRL research.',
url='https://github.com/PKU-MARL/omnisafe',
url='https://github.com/OmniSafeAI/omnisafe',
entry_points={'console_scripts': ['omnisafe=omnisafe.utils.command_app:app']},
packages=setuptools.find_namespace_packages(
include=['omnisafe', 'omnisafe.*'],
Expand Down
Loading

0 comments on commit ace1fe8

Please sign in to comment.