diff --git a/python/paddle/fluid/install_check.py b/python/paddle/fluid/install_check.py index 0e813e21ea3c0677fff8e9ac06af654ca52c02c4..ef469377acfbc0c2c521de61f8eacc0f7c9f0854 100644 --- a/python/paddle/fluid/install_check.py +++ b/python/paddle/fluid/install_check.py @@ -45,10 +45,23 @@ class SimpleLayer(Layer): def run_check(): - ''' install check to verify if install is success - + """To check whether install is successful This func should not be called only if you need to verify installation - ''' + + Examples: + .. code-block: python + + import paddle.fluid as fluid + fluid.install_check.run_check() + + # If installed successfully, output may be + # Running Verify Fluid Program ... + # W0805 04:24:59.496919 35357 device_context.cc:268] Please NOTE: device: 0, CUDA Capability: 70, Driver API Version: 10.2, Runtime API Version: 10.1 + # W0805 04:24:59.505594 35357 device_context.cc:276] device: 0, cuDNN Version: 7.6. + # Your Paddle Fluid works well on SINGLE GPU or CPU. + # Your Paddle Fluid works well on MUTIPLE GPU or CPU. + # Your Paddle Fluid is installed successfully! Let's start deep Learning with Paddle Fluid now + """ print("Running Verify Fluid Program ... ") device_list = [] diff --git a/tools/wlist.json b/tools/wlist.json index 6989882504eded7c56851e6e9351cef9b4975137..336109302dc47a5ec8782aff5bad095f9a50b01c 100644 --- a/tools/wlist.json +++ b/tools/wlist.json @@ -63,7 +63,6 @@ "Compressor", "Compressor.config", "Compressor.run", - "run_check", "HDFSClient.upload", "HDFSClient.download", "HDFSClient.is_exist",