Skip to content

Commit

Permalink
[docs] Updated conversation template doc (#3020)
Browse files Browse the repository at this point in the history
[docs] Updated path pointers in both docs files to point to the
`conversation_template` directory instead of linking to the
non-existent `conversation_template.py` file.

Co-authored-by: 涧波 <[email protected]>
  • Loading branch information
Kaneki-x and 涧波 authored Nov 13, 2024
1 parent 9214f71 commit b68f7b7
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/compilation/convert_weights.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,8 @@ See :ref:`compile-command-specification` for specification of ``gen_config``.
``dist/RedPajama-INCITE-Instruct-3B-v1-q4f16_1-MLC/mlc-chat-config.json`` (checkout :ref:`configure-mlc-chat-json` for more detailed instructions).
You can also simply use the default configuration.

`conversation_template.py <https://github.com/mlc-ai/mlc-llm/blob/main/python/mlc_llm/conversation_template.py>`__
contains a full list of conversation templates that MLC provides. If the model you are adding
`conversation_template <https://github.com/mlc-ai/mlc-llm/blob/main/python/mlc_llm/conversation_template>`__
directory contains a full list of conversation templates that MLC provides. If the model you are adding
requires a new conversation template, you would need to add your own.
Follow `this PR <https://github.com/mlc-ai/mlc-llm/pull/2163>`__ as an example. However,
adding your own template would require you :ref:`build mlc_llm from source <mlcchat_build_from_source>` in order for it
Expand Down
2 changes: 1 addition & 1 deletion docs/deploy/mlc_chat_config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ supported conversation templates:
- ``phi-2``
- ...

Please refer to `conversation_template.py <https://github.com/mlc-ai/mlc-llm/blob/main/python/mlc_llm/conversation_template.py>`_ for the full list of supported templates and their implementations.
Please refer to `conversation_template <https://github.com/mlc-ai/mlc-llm/blob/main/python/mlc_llm/conversation_template>`_ directory for the full list of supported templates and their implementations.

Below is a generic structure of a JSON conversation configuration (we use vicuna as an example):

Expand Down

0 comments on commit b68f7b7

Please sign in to comment.