@@ -97,3 +97,86 @@ def sdc_pandas_read_csv(fname, sep=',', delimiter=None, skiprows=0):
9797 csv_reader_py = _gen_csv_reader_py_pyarrow_py_func (func_text , func_name )
9898
9999 return csv_reader_py
100+
101+
102+ sdc_pandas_read_csv .__doc__ = r"""
103+ Intel Scalable Dataframe Compiler User Guide
104+ ********************************************
105+
106+ Pandas API: pandas.read_csv
107+
108+ Limitations
109+ -----------
110+ - Parameters \
111+ ``header``, \
112+ ``index_col``, \
113+ ``squeeze``, \
114+ ``prefix``, \
115+ ``mangle_dupe_cols``, \
116+ ``engine``, \
117+ ``converters``, \
118+ ``true_values``, \
119+ ``false_values``, \
120+ ``skipinitialspace``, \
121+ ``skipfooter``, \
122+ ``nrows``, \
123+ ``na_values``, \
124+ ``keep_default_na``, \
125+ ``na_filter``, \
126+ ``verbose``, \
127+ ``skip_blank_lines``, \
128+ ``parse_dates``, \
129+ ``infer_datetime_format``, \
130+ ``keep_date_col``, \
131+ ``date_parser``, \
132+ ``dayfirst``, \
133+ ``cache_dates``, \
134+ ``iterator``, \
135+ ``chunksize``, \
136+ ``compression``, \
137+ ``thousands``, \
138+ ``decimal``, \
139+ ``lineterminator``, \
140+ ``quotechar``, \
141+ ``quoting``, \
142+ ``doublequote``, \
143+ ``escapechar``, \
144+ ``comment``, \
145+ ``encoding``, \
146+ ``dialect``, \
147+ ``error_bad_lines``, \
148+ ``warn_bad_lines``, \
149+ ``delim_whitespace``, \
150+ ``low_memory``, \
151+ ``memory_map`` and \
152+ ``float_precision`` \
153+ are currently unsupported by Intel Scalable Dataframe Compiler.
154+ - Resulting DataFrame type could be inferred from constant file name of from parameters. \
155+ ``filepath_or_buffer`` could be constant for inferencing from file. \
156+ ``filepath_or_buffer`` could be variable for inferencing from parameters if ``dtype`` is constant. \
157+ If both ``filepath_or_buffer`` and ``dtype`` are constants then default is inferencing from parameters.
158+ - For inferring from parameters ``names`` or ``usecols`` should be provided additionally to ``dtype``.
159+ - For inferring from file ``sep``, ``delimiter`` and ``skiprows`` should be constants or omitted.
160+ - ``names`` and ``usecols`` should be constants or omitted for both types of inferrencing.
161+ - ``usecols`` with list of ints is unsupported by Intel Scalable Dataframe Compiler.
162+
163+ Examples
164+ --------
165+ Inference from file. File name is constant. \
166+ Resulting DataFrame depends on CSV file content at the moment of compilation.
167+
168+ >>> pd.read_csv('data.csv') # doctest: +SKIP
169+
170+ Inference from file. File name, ``names``, ``usecols``, ``delimiter`` and ``skiprow`` are constants. \
171+ Resulting DataFrame contains one column ``A`` \
172+ with type of column depending on CSV file content at the moment of compilation.
173+
174+ >>> pd.read_csv('data.csv', names=['A','B'], usecols=['A'], delimiter=';', skiprows=2) # doctest: +SKIP
175+
176+ Inference from parameters. File name, ``delimiter`` and ``skiprow`` are variables. \
177+ ``names``, ``usecols`` and ``dtype`` are constants. \
178+ Resulting DataFrame contains column ``A`` with type ``np.float64``.
179+
180+ >>> pd.read_csv(file_name, names=['A','B'], usecols=['A'], dtype={'A': np.float64}, \
181+ delimiter=some_char, skiprows=some_int) # doctest: +SKIP
182+ """
0 commit comments