From d06a64d84f1757dfc0ebf38f8e90f1fb1c84c8cc Mon Sep 17 00:00:00 2001 From: Zhiyuan Chen Date: Tue, 26 Mar 2024 01:19:05 +0800 Subject: [PATCH] update docs Signed-off-by: Zhiyuan Chen --- README.md | 6 +++--- README.zh.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0f01c35a..b9980e6f 100755 --- a/README.md +++ b/README.md @@ -77,12 +77,12 @@ Moreover, [`FlatDict`][chanfig.FlatDict] comes with [`difference`][chanfig.FlatD [`FlatDict`][chanfig.FlatDict] supports [`to`][chanfig.FlatDict.to] method similar to PyTorch Tensor. You can simply convert all member values of [`FlatDict`][chanfig.FlatDict] to a certain type or pass to a device in the same way. -[`FlatDict`][chanfig.FlatDict] also integrates `cpu`, `gpu` (`cuda`), and `tpu` (`xla`) methods for easier access. +[`FlatDict`][chanfig.FlatDict] also integrates [`cpu`][chanfig.FlatDict.cpu], [`gpu`][chanfig.FlatDict.gpu] ([`cuda`][chanfig.FlatDict.cuda]), and [`tpu`][chanfig.FlatDict.tpu] ([`xla`][chanfig.FlatDict.xla]) methods for easier access. #### IO Operations -[`FlatDict`][chanfig.FlatDict] provides `json`, `jsons`, `yaml` and `yamls` methods to dump [`FlatDict`][chanfig.FlatDict] to a file or string. -It also provides `from_json`, `from_jsons`, `from_yaml` and `from_yamls` methods to build a [`FlatDict`][chanfig.FlatDict] from a string or file. +[`FlatDict`][chanfig.FlatDict] provides [`json`][chanfig.FlatDict.json], [`jsons`][chanfig.FlatDict.jsons], [`yaml`][chanfig.FlatDict.yaml] and [`yamls`][chanfig.FlatDict.yamls] methods to dump [`FlatDict`][chanfig.FlatDict] to a file or string. +It also provides [`from_json`][chanfig.FlatDict.from_json], [`from_jsons`][chanfig.FlatDict.from_jsons], [`from_yaml`][chanfig.FlatDict.from_yaml] and [`from_yamls`][chanfig.FlatDict.from_yamls] methods to build a [`FlatDict`][chanfig.FlatDict] from a string or file. [`FlatDict`][chanfig.FlatDict] also includes `dump` and `load` methods which determine the type by their extension and dump/load [`FlatDict`][chanfig.FlatDict] to/from a file. diff --git a/README.zh.md b/README.zh.md index 03549078..60df6a64 100644 --- a/README.zh.md +++ b/README.zh.md @@ -73,12 +73,12 @@ Python 的`dict`自 Python 3.7 之后就是有序的，但是并没有一个内 [`FlatDict`][chanfig.FlatDict]支持与 Pytorch Tensor 类似的[`to`][chanfig.FlatDict.to]方法。 你可以很简单的通过相同的方式将所有[`FlatDict`][chanfig.FlatDict]的成员值转换为某种类型或者转移到某个设备上。 -[`FlatDict`][chanfig.FlatDict]同时集成了`cpu`、`gpu` (`cuda`)、`tpu` (`xla`)方法来提供更便捷的访问。 +[`FlatDict`][chanfig.FlatDict]同时集成了[`cpu`][chanfig.FlatDict.cpu]、[`gpu`][chanfig.FlatDict.gpu] ([`cuda`][chanfig.FlatDict.cuda])、[`tpu`][chanfig.FlatDict.tpu] ([`xla`][chanfig.FlatDict.xla])方法来提供更便捷的访问。 #### IO 操作 -[`FlatDict`][chanfig.FlatDict]支持`json`、`jsons`、`yaml`和`yamls`方法来将[`FlatDict`][chanfig.FlatDict]存储到文件或者转换成字符串。 -它还提供了`from_json`、`from_jsons`、`from_yaml`和`from_yamls`来从一个字符串或者文件中构建[`FlatDict`][chanfig.FlatDict]。 +[`FlatDict`][chanfig.FlatDict]支持[`json`][chanfig.FlatDict.json]、[`jsons`][chanfig.FlatDict.jsons]、[`yaml`][chanfig.FlatDict.yaml]和[`yamls`][chanfig.FlatDict.yamls]方法来将[`FlatDict`][chanfig.FlatDict]存储到文件或者转换成字符串。 +它还提供了[`from_json`][chanfig.FlatDict.from_json]、[`from_jsons`][chanfig.FlatDict.from_jsons]、[`from_yaml`][chanfig.FlatDict.from_yaml]和[`from_yamls`][chanfig.FlatDict.from_yamls]来从一个字符串或者文件中构建[`FlatDict`][chanfig.FlatDict]。 [`FlatDict`][chanfig.FlatDict]也包括了`dump`和`load`方法，他们可以从文件扩展名中自动推断类型然后将[`FlatDict`][chanfig.FlatDict]存储到文件中/从文件中加载[`FlatDict`][chanfig.FlatDict]。