tired....

Author: Ricardo-shuo-liu

.github/CODEOWNERS

@@ -1,2 +1,2 @@
 # Paddle API Docs
-docs/api/paddle @jzhang533 @sunzhongkai588 @mattheliu @Echo-Nie
+docs/api/paddle @jzhang533 @sunzhongkai588 @mattheliu @Echo-Nie @ooooo-create

.gitignore

@@ -6,6 +6,7 @@
 # virtualenv
 venv/
 ENV/
+.venv/
 
 # Compiled Python files
 __pycache__/

_typos.toml

@@ -18,6 +18,8 @@ extend-ignore-re = [
 CANN = "CANN"
 Clas = "Clas"
 arange = "arange"
+unsupport = "unsupport"
+Nervana = "Nervana"
 
 # These words need to be fixed
 Accuray = "Accuray"
@@ -26,30 +28,20 @@ Archetecture = "Archetecture"
 Asynchoronous = "Asynchoronous"
 Attrbute = "Attrbute"
 Attribtue = "Attribtue"
-Bounary = "Bounary"
-Classification = "Classification"
-Comparison = "Comparison"
-Constructing = "Constructing"
+Classfication = "Classfication"
+Comparision = "Comparision"
+Contructing = "Contructing"
 Creenshot = "Creenshot"
-DELCARE = "DELCARE"
-Dateset = "Dateset"
-Discription = "Discription"
-Distrbuted = "Distrbuted"
-Driect = "Driect"
 Embeddding = "Embeddding"
 Embeding = "Embeding"
 Engish = "Engish"
-Fasle = "Fasle"
-Flase = "Flase"
 Generater = "Generater"
 Gloabal = "Gloabal"
 Imporvement = "Imporvement"
 Interfce = "Interfce"
 Kernal = "Kernal"
 Learing = "Learing"
 Moible = "Moible"
-Nervana = "Nervana"
-Numberic = "Numberic"
 Operaton = "Operaton"
 Optimizaing = "Optimizaing"
 Optimzier = "Optimzier"
@@ -75,32 +67,10 @@ Traning = "Traning"
 Transfomed = "Transfomed"
 The = "The"
 Ture = "Ture"
-Useage = "Useage"
-Varialble = "Varialble"
-Varible = "Varible"
-Varient = "Varient"
-Wether = "Wether"
 accordding = "accordding"
 accoustic = "accoustic"
 accpetance = "accpetance"
-accracy = "accracy"
-acutal = "acutal"
-apporach = "apporach"
-apporaches = "apporaches"
-arguements = "arguements"
-arguemnts = "arguemnts"
-assgin = "assgin"
-assginment = "assginment"
-auxilary = "auxilary"
-avaiable = "avaiable"
-baisc = "baisc"
-basci = "basci"
-beacuse = "beacuse"
-bechmark = "bechmark"
-benckmark = "benckmark"
-boradcast = "boradcast"
-brodcast = "brodcast"
-calculate = "calculate"
+caculate = "caculate"
 cantains = "cantains"
 chosen = "chosen"
 classification = "classification"
@@ -198,9 +168,6 @@ metrices = "metrices"
 muliply = "muliply"
 mulitplying = "mulitplying"
 mutbale = "mutbale"
-neeeded = "neeeded"
-nessesary = "nessesary"
-numberic = "numberic"
 occurence = "occurence"
 opeartor = "opeartor"
 opeartors = "opeartors"
@@ -263,20 +230,3 @@ transfered = "transfered"
 trasformed = "trasformed"
 treshold = "treshold"
 trian = "trian"
-unqiue = "unqiue"
-unsupport = "unsupport"
-updte = "updte"
-utill = "utill"
-varialbes = "varialbes"
-varibale = "varibale"
-varibales = "varibales"
-varience = "varience"
-varient = "varient"
-visting = "visting"
-warpped = "warpped"
-wether = "wether"
-wiht = "wiht"
-wirte = "wirte"
-workign = "workign"
-wraper = "wraper"
-writter = "writter"

ci_scripts/check_api_label_cn.py

@@ -77,7 +77,7 @@ def run_cn_api_label_checking(rootdir, files):
     for file in files:
         if should_test(file) and not check_api_label(rootdir, file):
             logger.error(
-                f"The first line in {rootdir}/{file} is not avaiable, please re-check it!"
+                f"The first line in {rootdir}/{file} is not available, please re-check it!"
             )
             sys.exit(1)
     valid_api_labels = find_all_api_labels_in_dir(rootdir)

ci_scripts/ci_start.sh

@@ -57,10 +57,6 @@ if [ "${BUILD_DOC}" = "true" ] &&  [ -x /usr/local/bin/sphinx-build ] ; then
     git reset --hard && git clean -dfx
     cd ${DIR_PATH}
 
-    if [ -n "${BOS_CREDENTIAL_AK}" ] && [ -n "${BOS_CREDENTIAL_SK}" ] ; then
-        echo "Ak = ${BOS_CREDENTIAL_AK}" >> ${BCECMD_CONFIG}/credentials
-        echo "Sk = ${BOS_CREDENTIAL_SK}" >> ${BCECMD_CONFIG}/credentials
-    fi
     if [ $xdebug_setted ] ; then
         set -x
     fi
@@ -70,14 +66,12 @@ if [ "${BUILD_DOC}" = "true" ] &&  [ -x /usr/local/bin/sphinx-build ] ; then
     if [ "${UPLOAD_DOC}" = "true" ] ; then
         PREVIEW_JOB_NAME="preview-pr-${GIT_PR_ID}"
         BOSBUCKET=${BOSBUCKET:=paddle-site-web-dev}
-        ${BCECMD} --conf-path ${BCECMD_CONFIG} bos sync "${OUTPUTDIR}/en/${VERSIONSTR}" "bos:/${BOSBUCKET}/documentation/en/${PREVIEW_JOB_NAME}" \
-            --delete --yes --exclude "${OUTPUTDIR}/en/${VERSIONSTR}/_sources/"
-        ${BCECMD} --conf-path ${BCECMD_CONFIG} bos sync "${OUTPUTDIR}/en/${VERSIONSTR}" "bos:/${BOSBUCKET}/documentation/en/${PREVIEW_JOB_NAME}" \
-            --delete --yes --exclude "${OUTPUTDIR}/en/${VERSIONSTR}/_sources/"
-        ${BCECMD} --conf-path ${BCECMD_CONFIG} bos sync "${OUTPUTDIR}/zh/${VERSIONSTR}" "bos:/${BOSBUCKET}/documentation/zh/${PREVIEW_JOB_NAME}" \
-            --delete --yes --exclude "${OUTPUTDIR}/zh/${VERSIONSTR}/_sources/"
-        ${BCECMD} --conf-path ${BCECMD_CONFIG} bos sync "${OUTPUTDIR}/zh/${VERSIONSTR}" "bos:/${BOSBUCKET}/documentation/zh/${PREVIEW_JOB_NAME}" \
-            --delete --yes --exclude "${OUTPUTDIR}/zh/${VERSIONSTR}/_sources/"
+        wget -q --no-proxy https://xly-devops.bj.bcebos.com/home/bos_dir.tar --no-check-certificate
+        tar xf bos_dir.tar
+        python3 -m pip install bce-python-sdk==0.8.74
+        # use bos_der.tar: The first parameter is to upload the directory, the second parameter is to upload the BOS directory, and the third parameter is to exclude the directory
+        python3 BosClient.py ${OUTPUTDIR}/en/${VERSIONSTR} ${BOSBUCKET}/documentation/en/${PREVIEW_JOB_NAME} ${OUTPUTDIR}/en/${VERSIONSTR}/_sources/
+        python3 BosClient.py ${OUTPUTDIR}/zh/${VERSIONSTR} ${BOSBUCKET}/documentation/zh/${PREVIEW_JOB_NAME} ${OUTPUTDIR}/zh/${VERSIONSTR}/_sources/
         # print preview url
         PREVIEW_URL_PROMPT="ipipe_log_param_preview_url: http://${PREVIEW_JOB_NAME}.${PREVIEW_SITE:-preview.paddlepaddle.org}/documentation/docs/zh/api/index_cn.html"
     fi

ci_scripts/hooks/pre-doc-compile.sh

@@ -5,55 +5,118 @@ SCRIPT_DIR="$( cd "$( dirname "$0" )" && pwd )"
 
 FLUIDDOCDIR=${FLUIDDOCDIR:=/FluidDoc}
 DOCROOT=${FLUIDDOCDIR}/docs
-
-
-## 1. 获取API映射文件
 APIMAPPING_ROOT=${DOCROOT}/guides/model_convert/convert_from_pytorch
 TOOLS_DIR=${APIMAPPING_ROOT}/tools
 
-# 确保tools目录存在
-mkdir -p ${TOOLS_DIR}
+# Create tools directory if not exists
+if [ ! -d "${TOOLS_DIR}" ]; then
+    echo "INFO: Creating tools directory at ${TOOLS_DIR}"
+    mkdir -p "${TOOLS_DIR}"
+    if [ $? -ne 0 ]; then
+        echo "ERROR: Failed to create directory ${TOOLS_DIR}"
+        exit 1
+    fi
+else
+    echo "INFO: Tools directory ${TOOLS_DIR} already exists"
+fi
 
-#下载的文件URL
+# Define API mapping files URLs
 API_ALIAS_MAPPING_URL="https://raw.githubusercontent.com/PaddlePaddle/PaConvert/master/paconvert/api_alias_mapping.json"
 API_MAPPING_URL="https://raw.githubusercontent.com/PaddlePaddle/PaConvert/master/paconvert/api_mapping.json"
 GLOBAL_VAR_URL="https://raw.githubusercontent.com/PaddlePaddle/PaConvert/master/paconvert/global_var.py"
 ATTRIBUTE_MAPPING_URL="https://raw.githubusercontent.com/PaddlePaddle/PaConvert/master/paconvert/attribute_mapping.json"
 
-# 下载文件
+# Check for proxy settings
 PROXY=""
 if [ -n "$https_proxy" ]; then
     PROXY="$https_proxy"
+    echo "INFO: Using proxy"
 elif [ -n "$http_proxy" ]; then
     PROXY="$http_proxy"
+    echo "INFO: Using proxy"
+else
+    echo "INFO: No proxy detected, downloading directly."
 fi
 
-# 构建 curl 代理参数
-CURL_PROXY_ARGS=""
+# Build curl proxy arguments
 if [ -n "$PROXY" ]; then
-    CURL_PROXY_ARGS="--proxy $PROXY"
+    CURL_PROXY_ARGS="--proxy ${PROXY}"
 else
-    echo "No proxy detected, downloading directly."
+    CURL_PROXY_ARGS=""
 fi
 
-# 执行下载
-curl $CURL_PROXY_ARGS -o "${TOOLS_DIR}/api_alias_mapping.json" -s "${API_ALIAS_MAPPING_URL}"
-curl $CURL_PROXY_ARGS -o "${TOOLS_DIR}/api_mapping.json" -s "${API_MAPPING_URL}"
-curl $CURL_PROXY_ARGS -o "${TOOLS_DIR}/global_var.py" -s "${GLOBAL_VAR_URL}"
-curl $CURL_PROXY_ARGS -o "${TOOLS_DIR}/attribute_mapping.json" -s "${ATTRIBUTE_MAPPING_URL}"
+# Handle failure: copy cached file and exit
+handle_failure() {
+    local cached_file="${APIMAPPING_ROOT}/cached_pytorch_api_mapping_cn.md"
+    local target_file="${APIMAPPING_ROOT}/pytorch_api_mapping_cn.md"
+
+    if [ -f "$cached_file" ]; then
+        echo "INFO: Copying cached file to target: $cached_file -> $target_file"
+        cp "$cached_file" "$target_file"
+        echo "INFO: Successfully copied cached file to $target_file"
+        exit 0
+    else
+        echo "ERROR: Cached file not found at $cached_file"
+        exit 1
+    fi
+}
+
+# Download file with retry and failure handling
+download_file() {
+    local url=$1
+    local dest=$2
+    local filename=$(basename "$dest")
+    local max_retries=3
+    local retry_count=0
+
+    echo "INFO: Starting download of ${filename} from ${url}"
 
-# 检查下载是否成功
-if [ $? -ne 0 ]; then
-    echo "Error: Failed to download API mapping files"
-    exit 1
+    while [ $retry_count -lt $max_retries ]; do
+        retry_count=$((retry_count + 1))
+        echo "INFO: Attempt $retry_count of $max_retries to download ${filename}"
+
+        if curl $CURL_PROXY_ARGS -o "${dest}" -s "${url}" > /dev/null 2>&1; then
+            echo "SUCCESS: Successfully downloaded ${filename} to ${dest}"
+            return 0
+        else
+            echo "WARNING: Failed to download ${filename} from ${url} (attempt $retry_count)"
+            sleep 2  # Wait for 2 seconds before next retry
+        fi
+    done
+
+    echo "ERROR: Failed to download ${filename} after $max_retries attempts"
+    handle_failure
+}
+
+# Download all API mapping files
+download_file "${API_ALIAS_MAPPING_URL}" "${TOOLS_DIR}/api_alias_mapping.json"
+download_file "${API_MAPPING_URL}" "${TOOLS_DIR}/api_mapping.json"
+download_file "${GLOBAL_VAR_URL}" "${TOOLS_DIR}/global_var.py"
+download_file "${ATTRIBUTE_MAPPING_URL}" "${TOOLS_DIR}/attribute_mapping.json"
+
+echo "INFO: All API mapping files successfully downloaded"
+
+# Run the remaining scripts with failure handling
+echo "INFO: Running get_api_difference_info.py"
+if ! python "${APIMAPPING_ROOT}/tools/get_api_difference_info.py"; then
+    handle_failure
 fi
 
-## 3. Apply PyTorch-PaddlePaddle mapping using the new API mapping files
-python ${APIMAPPING_ROOT}/tools/get_api_difference_info.py
-python ${APIMAPPING_ROOT}/tools/generate_pytorch_api_mapping.py
+echo "INFO: Running generate_pytorch_api_mapping.py"
+if ! python "${APIMAPPING_ROOT}/tools/generate_pytorch_api_mapping.py"; then
+    handle_failure
+fi
 
+# Create backup of generated file
+BACKUP_FILE="${APIMAPPING_ROOT}/cached_pytorch_api_mapping_cn.md"
+GENERATED_FILE="${APIMAPPING_ROOT}/pytorch_api_mapping_cn.md"
 
-if [ $? -ne 0 ]; then
-    echo "Error: API mapping generate script failed, please check changes in ${APIMAPPING_ROOT}"
-    exit 1
+if [ -f "$GENERATED_FILE" ]; then
+    echo "INFO: Generated API mapping file successfully created at $GENERATED_FILE"
+    echo "INFO: Creating backup file: $BACKUP_FILE"
+    cp "$GENERATED_FILE" "$BACKUP_FILE"
+    echo "INFO: Successfully created backup file at $BACKUP_FILE"
+else
+    echo "ERROR: Generated API mapping file not found at $GENERATED_FILE"
+    handle_failure
 fi

docs/api/gen_alias_api.py

@@ -166,7 +166,7 @@ def generator_alias_api(self):
 
 if __name__ == "__main__":
     if len(sys.argv) != 2:
-        print("Useage:")
+        print("Usage:")
         print("python3 gen_alias_api.py path-to-paddle-root")
         sys.exit(1)
     else:

docs/api/gen_doc.py

@@ -943,7 +943,7 @@ def shortest(api_info):
 
 def insert_suggested_names():
     """
-    add suggested_name field, updte the doc_filename, and sort the all_names and api_sketch_names.
+    add suggested_name field, update the doc_filename, and sort the all_names and api_sketch_names.
     """
 
     def sort_name_list(api_names):

docs/api/paddle/incubate/autograd/Overview_cn.rst

@@ -225,7 +225,7 @@ _________________________
 - 输入数据不支持可变形状写法，如[None, 1]、[-1, 1]。如果训练数据形状是变化的，一种可行 Workaround 方案是根据不同数据形状创建不同网络，即在组网阶段将形状固定，具体参考附 1 代码。
 - 我们尚未在 windows 平台进行完整验证和支持。
 - 目前只支持使用 default_main_program 和 default_startup_program。
-- boradcast 语意尚未完整支持。
+- broadcast 语意尚未完整支持。
 
 
 .. _autograd_design_details:

docs/api/paddle/logical_xor_cn.rst

@@ -30,7 +30,7 @@ logical_xor
 
 返回
 ::::::::::::
- ``Tensor``，维度``x`` 维度相同，存储运算后的结果。
+``Tensor``，维度 ``x`` 维度相同，存储运算后的结果。
 
 代码示例
 ::::::::::::