Content-Length: 250669 | pFad | http://github.com/Sanyuan-Chen/swift/tree/main/docs

0E swift/docs at main · Sanyuan-Chen/swift · GitHub
Skip to content

Files

Failed to load latest commit information.

Latest commit

 Cannot retrieve latest commit at this time.

History

History
 
 

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

maintain docs

  1. build docs

    # in root directory:
    make docs
  2. doc string format

    We adopt the google style docstring format as the standard, please refer to the following documents.

    1. Google Python style guide docstring link
    2. Google docstring example link
    3. sample:torch.nn.modules.conv link
    4. load function as an example:
    def load(file, file_format=None, **kwargs):
        """Load data from json/yaml/pickle files.
    
        This method provides a unified api for loading data from serialized files.
    
        Args:
            file (str or :obj:`Path` or file-like object): Filename or a file-like
                object.
            file_format (str, optional): If not specified, the file format will be
                inferred from the file extension, otherwise use the specified one.
                Currently supported formats include "json", "yaml/yml".
    
        Examples:
            >>> load('/path/of/your/file')  # file is stored in disk
            >>> load('https://path/of/your/file')  # file is stored on internet
            >>> load('oss://path/of/your/file')  # file is stored in petrel
    
        Returns:
            The content from the file.
        """








ApplySandwichStrip

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

Fetched URL: http://github.com/Sanyuan-Chen/swift/tree/main/docs

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy