DataFrame Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A DataFrame to support indexing, binary operations, sorting, selection and other APIs. This will eventually also expose an IDataView for ML.NET
public class DataFrame : Microsoft.ML.IDataViewtype DataFrame = class
interface IDataViewPublic Class DataFrame
Implements IDataView- Inheritance
-
DataFrame
- Implements
Constructors
| DataFrame(DataFrameColumn[]) | |
| DataFrame(IEnumerable<DataFrameColumn>) |
Constructs a DataFrame with |
Properties
| Columns |
Returns the columns contained in the DataFrame as a DataFrameColumnCollection |
| Item[IEnumerable<Boolean>] |
Returns a new DataFrame using the boolean values in |
| Item[IEnumerable<Int32>] |
Returns a new DataFrame using the row indices in |
| Item[IEnumerable<Int64>] |
Returns a new DataFrame using the row indices in |
| Item[Int64, Int32] |
An Indexer to get or set values. |
| Item[PrimitiveDataFrameColumn<Boolean>] |
Returns a new DataFrame using the boolean values in filter |
| Item[PrimitiveDataFrameColumn<Int32>] |
Returns a new DataFrame using the row indices in |
| Item[PrimitiveDataFrameColumn<Int64>] |
Returns a new DataFrame using the row indices in |
| Item[String] |
An indexer based on Name |
| Rows |
Returns a DataFrameRowCollection that contains a view of the rows in this DataFrame |
Methods
| Add<T>(IReadOnlyList<T>, Boolean) | |
| Add<T>(T, Boolean) |
Performs an element-wise addition on each column |
| AddPrefix(String, Boolean) |
Adds a prefix to the column names |
| AddSuffix(String, Boolean) |
Adds a suffix to the column names |
| And(Boolean, Boolean) |
Performs an element-wise boolean And on each column |
| And(IReadOnlyList<Boolean>, Boolean) | |
| Append(IEnumerable<DataFrameRow>, Boolean, CultureInfo) |
Appends rows to the DataFrame |
| Append(IEnumerable<KeyValuePair<String,Object>>, Boolean, CultureInfo) |
Appends a row by enumerating column names and values from |
| Append(IEnumerable<Object>, Boolean, CultureInfo) |
Appends a row to the DataFrame |
| Clamp<U>(U, U, Boolean) |
Clamps values beyond the specified thresholds on numeric columns |
| Clone() |
Returns a full copy |
| Description() |
Generates descriptive statistics that summarize each numeric column |
| Divide<T>(IReadOnlyList<T>, Boolean) | |
| Divide<T>(T, Boolean) |
Performs an element-wise division on each column |
| DropNulls(DropNullOptions) |
Returns a DataFrame with no missing values |
| ElementwiseEquals<T>(IReadOnlyList<T>) | |
| ElementwiseEquals<T>(T) |
Performs an element-wise equals on each column |
| ElementwiseGreaterThan<T>(IReadOnlyList<T>) | |
| ElementwiseGreaterThan<T>(T) |
Performs an element-wise greater than on each column |
| ElementwiseGreaterThanOrEqual<T>(IReadOnlyList<T>) | |
| ElementwiseGreaterThanOrEqual<T>(T) |
Performs an element-wise greater than or equal on each column |
| ElementwiseLessThan<T>(IReadOnlyList<T>) | |
| ElementwiseLessThan<T>(T) |
Performs an element-wise less than on each column |
| ElementwiseLessThanOrEqual<T>(IReadOnlyList<T>) | |
| ElementwiseLessThanOrEqual<T>(T) |
Performs an element-wise less than or equal on each column |
| ElementwiseNotEquals<T>(IReadOnlyList<T>) | |
| ElementwiseNotEquals<T>(T) |
Performs an element-wise not-equals on each column |
| FillNulls(IList<Object>, Boolean) |
Fills |
| FillNulls(Object, Boolean) |
Fills |
| Filter(PrimitiveDataFrameColumn<Boolean>) |
Returns a new DataFrame using the boolean values in |
| Filter(PrimitiveDataFrameColumn<Int32>) |
Returns a new DataFrame using the row indices in |
| Filter(PrimitiveDataFrameColumn<Int64>) |
Returns a new DataFrame using the row indices in |
| FromArrowRecordBatch(RecordBatch) |
Wraps a DataFrame around an Arrow Apache.Arrow.RecordBatch without copying data |
| FromSchema(DbDataReader) | |
| GroupBy(String) |
Groups the rows of the DataFrame by unique values in the |
| GroupBy<TKey>(String) |
Groups the rows of the DataFrame by unique values in the |
| Head(Int32) |
Returns the first |
| Info() |
Generates a concise summary of each column in the DataFrame |
| Join(DataFrame, String, String, JoinAlgorithm) |
Joins columns of another DataFrame |
| LeftShift(Int32, Boolean) |
Performs an element-wise left shift on each column |
| LoadCsv(Stream, Char, Boolean, String[], Type[], Int64, Int32, Boolean, Encoding, Boolean, CultureInfo) |
Reads a seekable stream of CSV data into a DataFrame. |
| LoadCsv(String, Char, Boolean, String[], Type[], Int32, Int32, Boolean, Encoding, Boolean, CultureInfo) |
Reads a text file as a DataFrame. |
| LoadCsvFromString(String, Char, Boolean, String[], Type[], Int64, Int32, Boolean, Boolean, CultureInfo) |
Reads CSV data passed in as a string into a DataFrame. |
| LoadFrom(DbDataAdapter) | |
| LoadFrom(DbDataReader) | |
| LoadFrom(IEnumerable<IList<Object>>, IList<ValueTuple<String,Type>>) | |
| Merge(DataFrame, String[], String[], String, String, JoinAlgorithm) | |
| Merge<TKey>(DataFrame, String, String, String, String, JoinAlgorithm) |
Merge DataFrames with a database style join (for backward compatibility) |
| Modulo<T>(IReadOnlyList<T>, Boolean) | |
| Modulo<T>(T, Boolean) |
Performs an element-wise modulus operation on each column |
| Multiply<T>(IReadOnlyList<T>, Boolean) | |
| Multiply<T>(T, Boolean) |
Performs an element-wise multiplication on each column |
| Or(Boolean, Boolean) |
Performs an element-wise boolean Or on each column |
| Or(IReadOnlyList<Boolean>, Boolean) | |
| OrderBy(String) |
Orders the data frame by a specified column. |
| OrderByDescending(String) |
Orders the data frame by a specified column in descending order. |
| ReverseAdd<T>(T, Boolean) |
Performs a reversed element-wise addition on each column |
| ReverseAnd(Boolean, Boolean) |
Performs a reversed element-wise boolean And on each column |
| ReverseDivide<T>(T, Boolean) |
Performs a reversed element-wise division on each column |
| ReverseModulo<T>(T, Boolean) |
Performs a reversed element-wise modulus operation on each column |
| ReverseMultiply<T>(T, Boolean) |
Performs a reversed element-wise multiplication on each column |
| ReverseOr(Boolean, Boolean) |
Performs a reversed element-wise boolean Or on each column |
| ReverseSubtract<T>(T, Boolean) |
Performs a reversed element-wise subtraction on each column |
| ReverseXor(Boolean, Boolean) |
Performs a reversed element-wise boolean Xor on each column |
| RightShift(Int32, Boolean) |
Performs an element-wise right shift on each column |
| Sample(Int32) |
Returns a random sample of rows |
| SaveCsv(DataFrame, Stream, Char, Boolean, Encoding, CultureInfo) |
Saves a DataFrame into a CSV. |
| SaveCsv(DataFrame, String, Char, Boolean, Encoding, CultureInfo) |
Saves a DataFrame into a CSV. |
| SaveTo(DataTable) | |
| SaveTo(DbDataAdapter, DbProviderFactory) | |
| Subtract<T>(IReadOnlyList<T>, Boolean) | |
| Subtract<T>(T, Boolean) |
Performs an element-wise subtraction on each column |
| Tail(Int32) |
Returns the last |
| ToArrowRecordBatches() |
Returns an IEnumerable<T> mostly without copying data |
| ToString() |
A preview of the contents of this DataFrame as a string. |
| ToTable() | |
| WriteCsv(DataFrame, Stream, Char, Boolean, Encoding, CultureInfo) |
Obsolete.
Writes a DataFrame into a CSV. |
| WriteCsv(DataFrame, String, Char, Boolean, Encoding, CultureInfo) |
Obsolete.
Writes a DataFrame into a CSV. |
| Xor(Boolean, Boolean) |
Performs an element-wise boolean Xor on each column |
| Xor(IReadOnlyList<Boolean>, Boolean) | |
Operators
Explicit Interface Implementations
Extension Methods
| ToDataFrame(IDataView, Int64) |
Returns a DataFrame from this |
| ToDataFrame(IDataView, Int64, String[]) |
Returns a DataFrame with the first |
| ToDataFrame(IDataView, String[]) |
Returns a DataFrame with the first 100 rows of this |
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for