change markdown to reStructuredText.
This commit is contained in:
Oceania2018
parent
8963d1c5a7
commit
6bf552b20a
|
|
@ -1,6 +1,10 @@
|
|||
# <img src="https://raw.githubusercontent.com/Oceania2018/BotSharp/master/BotSharp.WebHost/wwwroot/images/BotSharp.png" height="30">
|
||||
### The Open Source AI Bot Platform Builder for Enterprise
|
||||
***"Conversation as a platform (CaaP) is the future, so it's perfect that we're already offering the whole toolkits to our enterprise developers using the BotSharp Bot Platform Builder to build a CaaP. It opens up as much learning power as possible for your enterprise robots and precisely control every step of the AI processing pipeline."***
|
||||
.. image:: https://raw.githubusercontent.com/Oceania2018/BotSharp/master/BotSharp.WebHost/wwwroot/images/BotSharp.png
|
||||
:height: 30px
|
||||
|
||||
The Open Source AI Bot Platform Builder for Enterprise
|
||||
======================================================
|
||||
|
||||
*"Conversation as a platform (CaaP) is the future, so it's perfect that we're already offering the whole toolkits to our enterprise developers using the BotSharp Bot Platform Builder to build a CaaP. It opens up as much learning power as possible for your enterprise robots and precisely control every step of the AI processing pipeline."*
|
||||
|
||||
**BotSharp** is an open source machine learning framework for AI Bot platform builder. This project involves natural language understanding, computer vision and audio processing technologies, and aims to promote the development and application of intelligent robot assistants in enterprise information systems. Out-of-the-box machine learning algorithms allow ordinary programmers to develop artificial intelligence applications faster and easier.
|
||||
|
||||
|
|
@ -10,56 +14,82 @@ Why we do this? because we all know python is not friendly programming language
|
|||
|
||||
BotSharp is in accordance with components princple strictly, decouples every part that needed in the platform builder. So you can choose different UI/UX, or pick up a different NLP Tagger, or select a more advanced algrithm to do NER task. They are all modulized based an unfied interfaces.
|
||||
|
||||
### Some Features
|
||||
Some Features
|
||||
-------------
|
||||
|
||||
* Built-in multi-Agents management, easy to build Bot as a Service platform.
|
||||
* Context In/ Out with lifespan to make conversion flow be controllable.
|
||||
* Use the natural language processing pipeline mechanism and the popular NLP algorithm library to build your own unique robot processing flow.
|
||||
* Support export/ import agent from other bot platforms directly.
|
||||
* Support different UI providers like [Rasa UI](https://github.com/paschmann/rasa-ui) and [Articulate UI](https://spg.ai/projects/articulate/).
|
||||
* Support export/ import agent from other bot platforms directly.
|
||||
* Support different UI providers like `Rasa UI`_ and `Articulate UI`_.
|
||||
* Support for multiple data request and response formats such as Rasa NLU and Dialogflow.
|
||||
* Integrate with popular social platforms like Facebook Messenger, Slack and Telegram.
|
||||
|
||||
### Documents
|
||||
Documents
|
||||
---------
|
||||
https://botsharp.readthedocs.io/en/latest
|
||||
|
||||
https://github.com/Oceania2018/BotSharp/wiki
|
||||
|
||||
## QUICK START
|
||||
### Building BotSharp
|
||||
Make sure the [Microsoft .NET Core](https://www.microsoft.com/net/download) build environment is installed.
|
||||
QUICK START
|
||||
-----------
|
||||
Building BotSharp
|
||||
^^^^^^^^^^^^^^^^^
|
||||
Make sure the `Microsoft .NET Core`_ build environment is installed.
|
||||
Building solution using dotnet CLI (preferred).
|
||||
```
|
||||
PS D:\> git clone https://github.com/Oceania2018/BotSharp
|
||||
PS D:\> cd BotSharp
|
||||
PS D:\> dotnet build
|
||||
```
|
||||
|
||||
### Install in docker container
|
||||
Make sure you've got [Docker](https://www.docker.com/) installed:
|
||||
```
|
||||
PS D:\> git clone https://github.com/Oceania2018/BotSharp
|
||||
PS D:\> cd BotSharp
|
||||
```
|
||||
::
|
||||
|
||||
PS D:\> git clone https://github.com/Oceania2018/BotSharp
|
||||
PS D:\> cd BotSharp
|
||||
PS D:\> dotnet build
|
||||
|
||||
Install in docker container
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Make sure you've got `Docker`_ installed:
|
||||
|
||||
::
|
||||
|
||||
PS D:\> git clone https://github.com/Oceania2018/BotSharp
|
||||
PS D:\> cd BotSharp
|
||||
|
||||
Build docker image:
|
||||
```
|
||||
PS D:\BotSharp\> docker build -t botsharp .
|
||||
```
|
||||
|
||||
::
|
||||
|
||||
PS D:\BotSharp\> docker build -t botsharp .
|
||||
|
||||
Start a container:
|
||||
```
|
||||
PS D:\BotSharp\> docker run -it -p 3112:3112 botsharp
|
||||
```
|
||||
|
||||
### Install in NuGet
|
||||
```
|
||||
PM> Install-Package BotSharp.Core
|
||||
PM> Install-Package BotSharp.RestApi
|
||||
```
|
||||
::
|
||||
|
||||
PS D:\BotSharp\> docker run -it -p 3112:3112 botsharp
|
||||
|
||||
|
||||
Install in NuGet
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
::
|
||||
|
||||
PM> Install-Package BotSharp.Core
|
||||
PM> Install-Package BotSharp.RestApi
|
||||
|
||||
Use BotSharp.NLP as a natural language processing toolkit alone.
|
||||
```
|
||||
PM> Install-Package BotSharp.NLP
|
||||
```
|
||||
|
||||
::
|
||||
|
||||
PM> Install-Package BotSharp.NLP
|
||||
|
||||
|
||||
#### Tip Jar
|
||||
* **Ethereum**
|
||||
|
||||
|
||||
##### 0x2FdE97210cd14F6020C67BAFA61d4c227FdC268d
|
||||
Tip Jar
|
||||
-------
|
||||
* Ethereum 0x2FdE97210cd14F6020C67BAFA61d4c227FdC268d
|
||||
|
||||
.. image:: https://raw.githubusercontent.com/Haiping-Chen/Etherscan.NetSDK/master/qr_code_eth.jpg
|
||||
:height: 160px
|
||||
|
||||
.. _Rasa UI: https://github.com/paschmann/rasa-ui
|
||||
.. _Articulate UI: https://spg.ai/projects/articulate
|
||||
.. _Microsoft .NET Core: https://www.microsoft.com/net/download
|
||||
.. _Docker: https://www.docker.com
|
||||
|
|
@ -47,7 +47,7 @@ templates_path = ['_templates']
|
|||
# You can specify multiple suffix as a list of string:
|
||||
#
|
||||
# source_suffix = ['.rst', '.md']
|
||||
source_suffix = '.rst'
|
||||
source_suffix = ['.rst', '.md']
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
|
@ -90,7 +90,7 @@ todo_include_todos = True
|
|||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = 'alabaster'
|
||||
html_theme = 'sphinx_rtd_theme'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@
|
|||
|
||||
Welcome to BotSharp's documentation!
|
||||
====================================
|
||||
.. include:: ../README.rst
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
|
@ -17,4 +18,4 @@ Indices and tables
|
|||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
* :ref:`search`
|
||||
Loading…
Reference in a new issue