Skip to content

Commit

Permalink
Merged PR 17671: Publish docs for Iron
Browse files Browse the repository at this point in the history
  • Loading branch information
QuinnRadich committed May 26, 2021
1 parent 5b948db commit cae359b
Show file tree
Hide file tree
Showing 873 changed files with 14,232 additions and 1,704 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
-api-id: M:Windows.AI.MachineLearning.LearningModelSessionOptions.OverrideNamedDimension(System.String,System.UInt32)
-api-type: winrt method
---

# Windows.AI.MachineLearning.LearningModelSessionOptions.OverrideNamedDimension(System.String,System.UInt32)

<!--
public void OverrideNamedDimension (string name, uint dimension);
-->


## -description

Provides the ability to override named input dimensions of a Learning Model to concrete values.

## -parameters

### -param name

The name of the input dimension to set.

### -param dimension

The concrete value to assign to the specified dimension.

## -remarks

Using this API can yield performance improvements, as it allows for preallocation of tensors during session creation that would otherwise be allocated during model evaluation.


## -see-also

[NamedDimensionOverride interface]()

## -examples

```cpp
void SetNamedDimensionOverrides(LearningModel model) {
// Create LearningModelSessionOptions
auto options = LearningModelSessionOptions();

// Override a named input dimension to a concrete value
options->OverrideNamedDimension(L"dimension_name", 256);

// Create session
LearningModelSession session = nullptr;
session = LearningModelSession(model, LearningModelDeviceKind::GPU, options);
}

```
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
-api-id: T:Windows.ApplicationModel.Activation.IPhoneCallActivatedEventArgs
-api-type: winrt interface
---

# Windows.ApplicationModel.Activation.IPhoneCallActivatedEventArgs

<!--
public interface IPhoneCallActivatedEventArgs : Windows.ApplicationModel.Activation.IActivatedEventArgs
-->


## -description

Represents the launch arguments for the application. The app’s `OnActivated` method will be invoked with the `PhoneCallActivatedEventArgs` class being the `activatedEventArg` payload.


## -remarks

## -see-also

## -examples


Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
-api-id: P:Windows.ApplicationModel.Activation.IPhoneCallActivatedEventArgs.LineId
-api-type: winrt property
---

# Windows.ApplicationModel.Activation.IPhoneCallActivatedEventArgs.LineId

<!--
public Guid LineId { get; }
-->


## -description

Identifies the PhoneLine being used. Used to retrieve a corresponding PhoneLine object.

## -property-value

## -remarks

## -see-also

## -examples


23 changes: 23 additions & 0 deletions windows.applicationmodel.activation/phonecallactivatedeventargs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
-api-id: T:Windows.ApplicationModel.Activation.PhoneCallActivatedEventArgs
-api-type: winrt class
---

# Windows.ApplicationModel.Activation.PhoneCallActivatedEventArgs

<!--
public sealed class PhoneCallActivatedEventArgs : Windows.ApplicationModel.Activation.IActivatedEventArgsWithUser, Windows.ApplicationModel.Activation.IPhoneCallActivatedEventArgs
-->


## -description

Represents the launch arguments for the application. The app’s `OnActivated` method will be invoked with the `PhoneCallActivatedEventArgs` class being the `activatedEventArg` payload.

## -remarks

## -see-also

## -examples


Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
-api-id: P:Windows.ApplicationModel.Activation.PhoneCallActivatedEventArgs.Kind
-api-type: winrt property
---

# Windows.ApplicationModel.Activation.PhoneCallActivatedEventArgs.Kind

<!--
public Windows.ApplicationModel.Activation.ActivationKind Kind { get; }
-->


## -description

Specifies the type of activation.

## -property-value

## -remarks

## -see-also

## -examples


Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
-api-id: P:Windows.ApplicationModel.Activation.PhoneCallActivatedEventArgs.LineId
-api-type: winrt property
---

# Windows.ApplicationModel.Activation.PhoneCallActivatedEventArgs.LineId

<!--
public Guid LineId { get; }
-->


## -description

Identifies the PhoneLine being used. Used to retrieve a corresponding PhoneLine object.

## -property-value

## -remarks

## -see-also

## -examples


Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
-api-id: P:Windows.ApplicationModel.Activation.PhoneCallActivatedEventArgs.PreviousExecutionState
-api-type: winrt property
---

# Windows.ApplicationModel.Activation.PhoneCallActivatedEventArgs.PreviousExecutionState

<!--
public Windows.ApplicationModel.Activation.ApplicationExecutionState PreviousExecutionState { get; }
-->


## -description

Gets the execution state of the app before this activation.

## -property-value

## -remarks

## -see-also

## -examples


Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
-api-id: P:Windows.ApplicationModel.Activation.PhoneCallActivatedEventArgs.SplashScreen
-api-type: winrt property
---

# Windows.ApplicationModel.Activation.PhoneCallActivatedEventArgs.SplashScreen

<!--
public Windows.ApplicationModel.Activation.SplashScreen SplashScreen { get; }
-->


## -description

The object that provides splash screen information.

## -property-value

## -remarks

## -see-also

## -examples


Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
-api-id: P:Windows.ApplicationModel.Activation.PhoneCallActivatedEventArgs.User
-api-type: winrt property
---

# Windows.ApplicationModel.Activation.PhoneCallActivatedEventArgs.User

<!--
public Windows.System.User User { get; }
-->


## -description

The user that the app was activated for.

## -property-value

## -remarks

## -see-also

## -examples


25 changes: 25 additions & 0 deletions windows.applicationmodel.core/applistentry_appinfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
-api-id: P:Windows.ApplicationModel.Core.AppListEntry.AppInfo
-api-type: winrt property
---

# Windows.ApplicationModel.Core.AppListEntry.AppInfo

<!--
public Windows.ApplicationModel.AppInfo AppInfo { get; }
-->


## -description

Provides information about an application such as its name, logo, package information, ID.

## -property-value

## -remarks

## -see-also

## -examples


25 changes: 25 additions & 0 deletions windows.applicationmodel.holographic/holographickeyboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
-api-id: T:Windows.ApplicationModel.Holographic.HolographicKeyboard
-api-type: winrt class
---

# Windows.ApplicationModel.Holographic.HolographicKeyboard

<!--
public sealed class HolographicKeyboard
-->


## -description

Enables apps to configure the system-provided Holographic keyboard.

## -remarks

Get an instance of this class by calling [HolographicKeyboard.GetDefault](holographickeyboard_getdefault_846721868.md).

## -see-also

## -examples


Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
-api-id: M:Windows.ApplicationModel.Holographic.HolographicKeyboard.GetDefault
-api-type: winrt method
---

# Windows.ApplicationModel.Holographic.HolographicKeyboard.GetDefault

<!--
public static Windows.ApplicationModel.Holographic.HolographicKeyboard GetDefault ();
-->


## -description

Gets the default instance of the [HolographicKeyboard](holographickeyboard.md) class.

## -returns

An instance of the [HolographicKeyboard](holographickeyboard.md) class.

## -remarks

## -see-also

## -examples


Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
-api-id: M:Windows.ApplicationModel.Holographic.HolographicKeyboard.ResetPlacementOverride
-api-type: winrt method
---

# Windows.ApplicationModel.Holographic.HolographicKeyboard.ResetPlacementOverride

<!--
public void ResetPlacementOverride ();
-->


## -description

Resets the placement override, allowing the keyboard to return to its default placement.

## -remarks

Set the placement override by calling one of the overloads of [HolographicKeyboard.SetPlacementOverride](holographickeyboard_setplacementoverride_502492960.md).

## -see-also

[HolographicKeyboard.SetPlacementOverride](holographickeyboard_setplacementoverride_502492960.md)

## -examples


Loading

0 comments on commit cae359b

Please sign in to comment.